SendLocation Class Reference
Constructors
Instance Methods
- getAddress() ⇒
OASISAddress - getAddressLines() ⇒
Array.<String> - getDeliveryMode() ⇒
DeliveryMode - getLatitudeDegrees() ⇒
Number - getLocationDescription() ⇒
String - getLocationImage() ⇒
Image - getLocationName() ⇒
String - getLongitudeDegrees() ⇒
Number - getPhoneNumber() ⇒
String - getTimeStamp() ⇒
DateTime - setAddress(address) ⇒
SendLocation - setAddressLines(lines) ⇒
SendLocation - setDeliveryMode(mode) ⇒
SendLocation - setLatitudeDegrees(degrees) ⇒
SendLocation - setLocationDescription(description) ⇒
SendLocation - setLocationImage(image) ⇒
SendLocation - setLocationName(name) ⇒
SendLocation - setLongitudeDegrees(degrees) ⇒
SendLocation - setPhoneNumber(number) ⇒
SendLocation - setTimeStamp(stamp) ⇒
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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| lines | Array.<String> |
Location address (if applicable) - The desired AddressLines. {'array_min_size': 0, 'array_max_size': 4, 'string_min_length': 1, 'string_max_length': 500} |
sendLocation.setDeliveryMode(mode) ⇒ SendLocation
Set the DeliveryMode
Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| degrees | Number |
The desired LatitudeDegrees. {'num_min_value': -90.0, 'num_max_value': 90.0} |
sendLocation.setLocationDescription(description) ⇒ SendLocation
Set the LocationDescription
Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| description | String |
Description intended location / establishment (if applicable) - The desired LocationDescription. {'string_min_length': 1, 'string_max_length': 500} |
sendLocation.setLocationImage(image) ⇒ SendLocation
Set the LocationImage
Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| name | String |
Name / title of intended location - The desired LocationName. {'string_min_length': 1, 'string_max_length': 500} |
sendLocation.setLongitudeDegrees(degrees) ⇒ SendLocation
Set the LongitudeDegrees
Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| degrees | Number |
The desired LongitudeDegrees. {'num_min_value': -180.0, 'num_max_value': 180.0} |
sendLocation.setPhoneNumber(number) ⇒ SendLocation
Set the PhoneNumber
Kind: Instance method of SendLocation
Returns: SendLocation - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| number | String |
Phone number of intended location / establishment (if applicable) - The desired PhoneNumber. {'string_min_length': 1, 'string_max_length': 500} |