Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
SendLocation

SendLocation Class Reference

Constructors

Instance Methods

Constructors

new SendLocation(parameters)

Initalizes an instance of SendLocation.

Instance Methods

sendLocation.getAddress() ⇒ OASISAddress

Get the Address

Kind: Instance method of SendLocation
Returns: OASISAddress - the KEY_ADDRESS value

sendLocation.getAddressLines() ⇒ Array.<String>

Get the AddressLines

Kind: Instance method of SendLocation
Returns: Array.<String> - the KEY_ADDRESS_LINES value

sendLocation.getDeliveryMode() ⇒ DeliveryMode

Get the DeliveryMode

Kind: Instance method of SendLocation
Returns: DeliveryMode - the KEY_DELIVERY_MODE value

sendLocation.getLatitudeDegrees() ⇒ Number

Get the LatitudeDegrees

Kind: Instance method of SendLocation
Returns: Number - the KEY_LATITUDE_DEGREES value

sendLocation.getLocationDescription() ⇒ String

Get the LocationDescription

Kind: Instance method of SendLocation
Returns: String - the KEY_LOCATION_DESCRIPTION value

sendLocation.getLocationImage() ⇒ Image

Get the LocationImage

Kind: Instance method of SendLocation
Returns: Image - the KEY_LOCATION_IMAGE value

sendLocation.getLocationName() ⇒ String

Get the LocationName

Kind: Instance method of SendLocation
Returns: String - the KEY_LOCATION_NAME value

sendLocation.getLongitudeDegrees() ⇒ Number

Get the LongitudeDegrees

Kind: Instance method of SendLocation
Returns: Number - the KEY_LONGITUDE_DEGREES value

sendLocation.getPhoneNumber() ⇒ String

Get the PhoneNumber

Kind: Instance method of SendLocation
Returns: String - the KEY_PHONE_NUMBER value

sendLocation.getTimeStamp() ⇒ DateTime

Get the TimeStamp

Kind: Instance method of SendLocation
Returns: DateTime - the KEY_TIME_STAMP value

sendLocation.setAddress(address) ⇒ SendLocation

Set the Address

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
address OASISAddress Address to be used for setting destination - The desired Address.

sendLocation.setAddressLines(lines) ⇒ SendLocation

Set the AddressLines

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
lines Array.<String> Location address (if applicable) - The desired AddressLines.

sendLocation.setDeliveryMode(mode) ⇒ SendLocation

Set the DeliveryMode

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
mode DeliveryMode Defines the mode of prompt for user - The desired DeliveryMode.

sendLocation.setLatitudeDegrees(degrees) ⇒ SendLocation

Set the LatitudeDegrees

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
degrees Number The desired LatitudeDegrees.

sendLocation.setLocationDescription(description) ⇒ SendLocation

Set the LocationDescription

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
description String Description intended location / establishment (if applicable) - The desired LocationDescription.

sendLocation.setLocationImage(image) ⇒ SendLocation

Set the LocationImage

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
image Image Image / icon of intended location (if applicable and supported) - The desired LocationImage.

sendLocation.setLocationName(name) ⇒ SendLocation

Set the LocationName

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
name String Name / title of intended location - The desired LocationName.

sendLocation.setLongitudeDegrees(degrees) ⇒ SendLocation

Set the LongitudeDegrees

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
degrees Number The desired LongitudeDegrees.

sendLocation.setPhoneNumber(number) ⇒ SendLocation

Set the PhoneNumber

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
number String Phone number of intended location / establishment (if applicable) - The desired PhoneNumber.

sendLocation.setTimeStamp(stamp) ⇒ SendLocation

Set the TimeStamp

Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.

ParamTypeDescription
stamp DateTime timestamp in ISO 8601 format - The desired TimeStamp.
View on GitHub.com
Previous Section Next Section