ask_sdk_model.interfaces.geolocation package¶

Submodules¶

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.interfaces.geolocation.access module¶

class ask_sdk_model.interfaces.geolocation.access.Access¶

Bases: enum.Enum

A string representing if Alexa has access to location services running on the hostOS of device.

Allowed enum values: [ENABLED, DISABLED, UNKNOWN]

DISABLED = 'DISABLED'¶

ENABLED = 'ENABLED'¶

UNKNOWN = 'UNKNOWN'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.altitude module¶

class ask_sdk_model.interfaces.geolocation.altitude.Altitude(altitude_in_meters=None, accuracy_in_meters=None)¶

Bases: object

An object containing the altitude information of the device.

Parameters:	altitude_in_meters ((optional) float) – A double representing the altitude of the device in meters. accuracy_in_meters ((optional) float) – A double representing the accuracy of the altitude measurement in meters.

attribute_map = {'accuracy_in_meters': 'accuracyInMeters', 'altitude_in_meters': 'altitudeInMeters'}¶

deserialized_types = {'accuracy_in_meters': 'float', 'altitude_in_meters': 'float'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.coordinate module¶

class ask_sdk_model.interfaces.geolocation.coordinate.Coordinate(latitude_in_degrees=None, longitude_in_degrees=None, accuracy_in_meters=None)¶

Bases: object

An object containing the location information of the device.

Parameters:	latitude_in_degrees ((optional) float) – A double representing the latitude in degrees of the device. longitude_in_degrees ((optional) float) – A double representing the longitude in degrees of the device. accuracy_in_meters ((optional) float) – A double representing the accuracy of geolocation data in meters.

attribute_map = {'accuracy_in_meters': 'accuracyInMeters', 'latitude_in_degrees': 'latitudeInDegrees', 'longitude_in_degrees': 'longitudeInDegrees'}¶

deserialized_types = {'accuracy_in_meters': 'float', 'latitude_in_degrees': 'float', 'longitude_in_degrees': 'float'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.geolocation_interface module¶

class ask_sdk_model.interfaces.geolocation.geolocation_interface.GeolocationInterface¶

Bases: object

attribute_map = {}¶

deserialized_types = {}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.geolocation_state module¶

class ask_sdk_model.interfaces.geolocation.geolocation_state.GeolocationState(timestamp=None, coordinate=None, altitude=None, heading=None, speed=None, location_services=None)¶

Bases: object

Parameters:

timestamp ((optional) str) – Specifies the time when the geolocation data was last collected on the device.
coordinate ((optional) ask_sdk_model.interfaces.geolocation.coordinate.Coordinate) –
altitude ((optional) ask_sdk_model.interfaces.geolocation.altitude.Altitude) –
heading ((optional) ask_sdk_model.interfaces.geolocation.heading.Heading) –
speed ((optional) ask_sdk_model.interfaces.geolocation.speed.Speed) –
location_services ((optional) ask_sdk_model.interfaces.geolocation.location_services.LocationServices) –

attribute_map = {'altitude': 'altitude', 'coordinate': 'coordinate', 'heading': 'heading', 'location_services': 'locationServices', 'speed': 'speed', 'timestamp': 'timestamp'}¶

deserialized_types = {'altitude': 'ask_sdk_model.interfaces.geolocation.altitude.Altitude', 'coordinate': 'ask_sdk_model.interfaces.geolocation.coordinate.Coordinate', 'heading': 'ask_sdk_model.interfaces.geolocation.heading.Heading', 'location_services': 'ask_sdk_model.interfaces.geolocation.location_services.LocationServices', 'speed': 'ask_sdk_model.interfaces.geolocation.speed.Speed', 'timestamp': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.heading module¶

class ask_sdk_model.interfaces.geolocation.heading.Heading(direction_in_degrees=None, accuracy_in_degrees=None)¶

Bases: object

An object containing the heading direction information of the device.

Parameters:	direction_in_degrees ((optional) float) – A double representing the direction of the device in degrees. accuracy_in_degrees ((optional) float) – A double representing the accuracy of the heading measurement in degrees.

attribute_map = {'accuracy_in_degrees': 'accuracyInDegrees', 'direction_in_degrees': 'directionInDegrees'}¶

deserialized_types = {'accuracy_in_degrees': 'float', 'direction_in_degrees': 'float'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.location_services module¶

class ask_sdk_model.interfaces.geolocation.location_services.LocationServices(status=None, access=None)¶

Bases: object

An object containing status and access.

Parameters:	status ((optional) ask_sdk_model.interfaces.geolocation.status.Status) – A string representing the status of whether location services is currently running or not on the host OS of device. access ((optional) ask_sdk_model.interfaces.geolocation.access.Access) – A string representing if Alexa has access to location services running on the hostOS of device.

attribute_map = {'access': 'access', 'status': 'status'}¶

deserialized_types = {'access': 'ask_sdk_model.interfaces.geolocation.access.Access', 'status': 'ask_sdk_model.interfaces.geolocation.status.Status'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.speed module¶

class ask_sdk_model.interfaces.geolocation.speed.Speed(speed_in_meters_per_second=None, accuracy_in_meters_per_second=None)¶

Bases: object

An object containing the speed information of the device.

Parameters:	speed_in_meters_per_second ((optional) float) – A double representing the speed of the device in meters. accuracy_in_meters_per_second ((optional) float) – A double representing the accuracy of the speed measurement in meters.

attribute_map = {'accuracy_in_meters_per_second': 'accuracyInMetersPerSecond', 'speed_in_meters_per_second': 'speedInMetersPerSecond'}¶

deserialized_types = {'accuracy_in_meters_per_second': 'float', 'speed_in_meters_per_second': 'float'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.geolocation.status module¶

class ask_sdk_model.interfaces.geolocation.status.Status¶

Bases: enum.Enum

A string representing the status of whether location services is currently running or not on the host OS of device.

Allowed enum values: [RUNNING, STOPPED]

RUNNING = 'RUNNING'¶

STOPPED = 'STOPPED'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model