SendLocation (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.SendLocation

All Implemented Interfaces:

Cloneable
```
public class SendLocation
extends RPCRequest
```
Sends a location to the head-unit to display on a map or list.

Since:

SmartDeviceLink 3.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ADDRESS`
`static String`	`KEY_ADDRESS_LINES`
`static String`	`KEY_DELIVERY_MODE`
`static String`	`KEY_LAT_DEGREES`
`static String`	`KEY_LOCATION_DESCRIPTION`
`static String`	`KEY_LOCATION_IMAGE`
`static String`	`KEY_LOCATION_NAME`
`static String`	`KEY_LON_DEGREES`
`static String`	`KEY_PHONE_NUMBER`
`static String`	`KEY_TIME_STAMP`

Fields inherited from class com.smartdevicelink.proxy.RPCRequest
onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage
function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`SendLocation()` Constructs a new SendLocation object
`SendLocation(Hashtable<String,Object> hash)` Constructs a new SendLocation object indicated by the Hashtable parameter

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OasisAddress`	`getAddress()`
`List<String>`	`getAddressLines()` Getter for address lines of the location to send.
`DeliveryMode`	`getDeliveryMode()`
`Double`	`getLatitudeDegrees()` Getter for latitude of the location to send.
`String`	`getLocationDescription()` Getter for description of the location to send.
`Image`	`getLocationImage()` Getter for image of the location to send.
`String`	`getLocationName()` Getter for name of the location to send.
`Double`	`getLongitudeDegrees()` Getter for longitude of the location to send.
`String`	`getPhoneNumber()` Getter for phone number of the location to send.
`DateTime`	`getTimeStamp()`
`SendLocation`	`setAddress(OasisAddress address)`
`SendLocation`	`setAddressLines(List<String> addressLines)` Setter for address lines of the location to send.
`SendLocation`	`setDeliveryMode(DeliveryMode deliveryMode)`
`SendLocation`	`setLatitudeDegrees(Double latitudeDegrees)` Setter for latitude of the location to send.
`SendLocation`	`setLocationDescription(String locationDescription)` Setter for description of the location to send.
`SendLocation`	`setLocationImage(Image locationImage)` Setter for image of the location to send.
`SendLocation`	`setLocationName(String locationName)` Setter for name of the location to send.
`SendLocation`	`setLongitudeDegrees(Double longitudeDegrees)` Setter for longitude of the location to send.
`SendLocation`	`setPhoneNumber(String phoneNumber)` Setter for phone number of the location to send.
`SendLocation`	`setTimeStamp(DateTime timeStamp)`

Methods inherited from class com.smartdevicelink.proxy.RPCRequest
getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage
getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_LAT_DEGREES
```
public static final String KEY_LAT_DEGREES
```
    See Also:
    
    Constant Field Values
  - KEY_LON_DEGREES
```
public static final String KEY_LON_DEGREES
```
    See Also:
    
    Constant Field Values
  - KEY_LOCATION_NAME
```
public static final String KEY_LOCATION_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_LOCATION_DESCRIPTION
```
public static final String KEY_LOCATION_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - KEY_PHONE_NUMBER
```
public static final String KEY_PHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - KEY_ADDRESS_LINES
```
public static final String KEY_ADDRESS_LINES
```
    See Also:
    
    Constant Field Values
  - KEY_LOCATION_IMAGE
```
public static final String KEY_LOCATION_IMAGE
```
    See Also:
    
    Constant Field Values
  - KEY_DELIVERY_MODE
```
public static final String KEY_DELIVERY_MODE
```
    See Also:
    
    Constant Field Values
  - KEY_TIME_STAMP
```
public static final String KEY_TIME_STAMP
```
    See Also:
    
    Constant Field Values
  - KEY_ADDRESS
```
public static final String KEY_ADDRESS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SendLocation
```
public SendLocation()
```
    Constructs a new SendLocation object
  - SendLocation
```
public SendLocation(Hashtable<String,Object> hash)
```
    Constructs a new SendLocation object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
- Method Detail
  - getLongitudeDegrees
```
public Double getLongitudeDegrees()
```
    Getter for longitude of the location to send.
    IMPORTANT NOTE:
    A previous version of this method call returned a Float value, however, it has been changed to return a Double.
    This will compile, but cause a ClassCastException if your value is not also a Double type.
    
    Returns:
    
    The longitude of the location
    
    Since:
    
    SmartDeviceLink v4.0
  - setLongitudeDegrees
```
public SendLocation setLongitudeDegrees(Double longitudeDegrees)
```
    Setter for longitude of the location to send.
    
    Parameters:
    
    longitudeDegrees - degrees of the longitudinal position
  - getLatitudeDegrees
```
public Double getLatitudeDegrees()
```
    Getter for latitude of the location to send.
    IMPORTANT NOTE:
    A previous version of this method call returned a Float value, however, it has been changed to return a Double.
    This will compile, but cause a ClassCastException if your value is not also a Double type.
    
    Returns:
    
    The latitude of the location
    
    Since:
    
    SmartDeviceLink v4.0
  - setLatitudeDegrees
```
public SendLocation setLatitudeDegrees(Double latitudeDegrees)
```
    Setter for latitude of the location to send.
    
    Parameters:
    
    latitudeDegrees - degrees of the latitudinal position
  - getLocationName
```
public String getLocationName()
```
    Getter for name of the location to send.
    
    Returns:
    
    The name of the location
  - setLocationName
```
public SendLocation setLocationName(String locationName)
```
    Setter for name of the location to send.
    
    Parameters:
    
    locationName - The name of the location
  - getLocationDescription
```
public String getLocationDescription()
```
    Getter for description of the location to send.
    
    Returns:
    
    The description of the location to send
  - setLocationDescription
```
public SendLocation setLocationDescription(String locationDescription)
```
    Setter for description of the location to send.
    
    Parameters:
    
    locationDescription - The description of the location
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Getter for phone number of the location to send.
    
    Returns:
  - setPhoneNumber
```
public SendLocation setPhoneNumber(String phoneNumber)
```
    Setter for phone number of the location to send.
    
    Parameters:
    
    phoneNumber - The phone number of the location
  - getAddressLines
```
public List<String> getAddressLines()
```
    Getter for address lines of the location to send.
    
    Returns:
    
    The address lines of the location
  - setAddressLines
```
public SendLocation setAddressLines(List<String> addressLines)
```
    Setter for address lines of the location to send.
    
    Parameters:
    
    addressLines - The address lines of the location
  - getLocationImage
```
public Image getLocationImage()
```
    Getter for image of the location to send.
    
    Returns:
    
    The image of the location to send
  - setLocationImage
```
public SendLocation setLocationImage(Image locationImage)
```
    Setter for image of the location to send.
    
    Parameters:
    
    locationImage - The image of the location to send
  - getDeliveryMode
```
public DeliveryMode getDeliveryMode()
```
  - setDeliveryMode
```
public SendLocation setDeliveryMode(DeliveryMode deliveryMode)
```
  - getTimeStamp
```
public DateTime getTimeStamp()
```
  - setTimeStamp
```
public SendLocation setTimeStamp(DateTime timeStamp)
```
  - getAddress
```
public OasisAddress getAddress()
```
  - setAddress
```
public SendLocation setAddress(OasisAddress address)
```

Class SendLocation

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_LAT_DEGREES

KEY_LON_DEGREES

KEY_LOCATION_NAME

KEY_LOCATION_DESCRIPTION

KEY_PHONE_NUMBER

KEY_ADDRESS_LINES

KEY_LOCATION_IMAGE

KEY_DELIVERY_MODE

KEY_TIME_STAMP

KEY_ADDRESS

Constructor Detail

SendLocation

SendLocation

Method Detail

getLongitudeDegrees

setLongitudeDegrees

getLatitudeDegrees

setLatitudeDegrees

getLocationName

setLocationName

getLocationDescription

setLocationDescription

getPhoneNumber

setPhoneNumber

getAddressLines

setAddressLines

getLocationImage

setLocationImage

getDeliveryMode

setDeliveryMode

getTimeStamp

setTimeStamp

getAddress

setAddress