Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
SendLocation

Class SendLocation

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

Overview

Sends a location to the head-unit to display on a map or list.

Quick Jump

Fields
Constructors
Methods

Fields

KEY_LAT_DEGREES

public static final java.lang.String KEY_LAT_DEGREES
Constant Value
"latitudeDegrees"

KEY_LON_DEGREES

public static final java.lang.String KEY_LON_DEGREES
Constant Value
"longitudeDegrees"

KEY_LOCATION_NAME

public static final java.lang.String KEY_LOCATION_NAME
Constant Value
"locationName"

KEY_LOCATION_DESCRIPTION

public static final java.lang.String KEY_LOCATION_DESCRIPTION
Constant Value
"locationDescription"

KEY_PHONE_NUMBER

public static final java.lang.String KEY_PHONE_NUMBER
Constant Value
"phoneNumber"

KEY_ADDRESS_LINES

public static final java.lang.String KEY_ADDRESS_LINES
Constant Value
"addressLines"

KEY_LOCATION_IMAGE

public static final java.lang.String KEY_LOCATION_IMAGE
Constant Value
"locationImage"

KEY_DELIVERY_MODE

public static final java.lang.String KEY_DELIVERY_MODE
Constant Value
"deliveryMode"

KEY_TIME_STAMP

public static final java.lang.String KEY_TIME_STAMP
Constant Value
"timeStamp"

KEY_ADDRESS

public static final java.lang.String KEY_ADDRESS
Constant Value
"address"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

SendLocation()

Constructs a new SendLocation object 

public SendLocation()

SendLocation( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new SendLocation object indicated by the Hashtable parameter 

public SendLocation(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

Methods

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. 

public java.lang.Double getLongitudeDegrees()

setLongitudeDegrees( Double longitudeDegrees )

Setter for longitude of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setLongitudeDegrees(Double longitudeDegrees)

Method Parameters

longitudeDegrees
degrees of the longitudinal position

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. 

public java.lang.Double getLatitudeDegrees()

setLatitudeDegrees( Double latitudeDegrees )

Setter for latitude of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setLatitudeDegrees(Double latitudeDegrees)

Method Parameters

latitudeDegrees
degrees of the latitudinal position

getLocationName()

Getter for name of the location to send. 

public java.lang.String getLocationName()

setLocationName( String locationName )

Setter for name of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setLocationName(String locationName)

Method Parameters

locationName
The name of the location

getLocationDescription()

Getter for description of the location to send. 

public java.lang.String getLocationDescription()

setLocationDescription( String locationDescription )

Setter for description of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setLocationDescription(String locationDescription)

Method Parameters

locationDescription
The description of the location

getPhoneNumber()

Getter for phone number of the location to send. 

public java.lang.String getPhoneNumber()

setPhoneNumber( String phoneNumber )

Setter for phone number of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setPhoneNumber(String phoneNumber)

Method Parameters

phoneNumber
The phone number of the location

getAddressLines()

Getter for address lines of the location to send. 

public java.util.List getAddressLines()

setAddressLines( java.util.List<java.lang.String> addressLines )

Setter for address lines of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setAddressLines(java.util.List<java.lang.String> addressLines)

Method Parameters

addressLines
The address lines of the location

getLocationImage()

Getter for image of the location to send. 

public com.smartdevicelink.proxy.rpc.Image getLocationImage()

setLocationImage( Image locationImage )

Setter for image of the location to send. 

public com.smartdevicelink.proxy.rpc.SendLocation setLocationImage(Image locationImage)

Method Parameters

locationImage
The image of the location to send

getDeliveryMode()

public com.smartdevicelink.proxy.rpc.enums.DeliveryMode getDeliveryMode()

setDeliveryMode( DeliveryMode deliveryMode )

public com.smartdevicelink.proxy.rpc.SendLocation setDeliveryMode(DeliveryMode deliveryMode)

Method Parameters

deliveryMode

getTimeStamp()

public com.smartdevicelink.proxy.rpc.DateTime getTimeStamp()

setTimeStamp( DateTime timeStamp )

public com.smartdevicelink.proxy.rpc.SendLocation setTimeStamp(DateTime timeStamp)

Method Parameters

timeStamp

getAddress()

public com.smartdevicelink.proxy.rpc.OasisAddress getAddress()

setAddress( OasisAddress address )

public com.smartdevicelink.proxy.rpc.SendLocation setAddress(OasisAddress address)

Method Parameters

address

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section