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

NavigationInstruction Class Reference

Constructors

Instance Methods

Constructors

new NavigationInstruction(parameters)

Initalizes an instance of NavigationInstruction.

Instance Methods

navigationInstruction.getAction() ⇒ NavigationAction

Get the Action

Kind: Instance method of NavigationInstruction
Returns: NavigationAction - the KEY_ACTION value

navigationInstruction.getBearing() ⇒ Number

Get the Bearing

Kind: Instance method of NavigationInstruction
Returns: Number - the KEY_BEARING value

navigationInstruction.getDetails() ⇒ String

Get the Details

Kind: Instance method of NavigationInstruction
Returns: String - the KEY_DETAILS value

navigationInstruction.getDrivingSide() ⇒ Direction

Get the DrivingSide

Kind: Instance method of NavigationInstruction
Returns: Direction - the KEY_DRIVING_SIDE value

navigationInstruction.getEta() ⇒ DateTime

Get the Eta

Kind: Instance method of NavigationInstruction
Returns: DateTime - the KEY_ETA value

navigationInstruction.getImage() ⇒ Image

Get the Image

Kind: Instance method of NavigationInstruction
Returns: Image - the KEY_IMAGE value

navigationInstruction.getJunctionType() ⇒ NavigationJunction

Get the JunctionType

Kind: Instance method of NavigationInstruction
Returns: NavigationJunction - the KEY_JUNCTION_TYPE value

navigationInstruction.getLocationDetails() ⇒ LocationDetails

Get the LocationDetails

Kind: Instance method of NavigationInstruction
Returns: LocationDetails - the KEY_LOCATION_DETAILS value

navigationInstruction.setAction(action) ⇒ NavigationInstruction

Set the Action

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

ParamTypeDescription
action NavigationAction The desired Action.

navigationInstruction.setBearing(bearing) ⇒ NavigationInstruction

Set the Bearing

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

ParamTypeDescription
bearing Number The angle at which this instruction takes place. For example, 0 would mean straight, - The desired Bearing. less than 45 is bearing right, greater than 135 is sharp right, between 45 and 135 is a regular right, and 180 is a U-Turn, etc.

navigationInstruction.setDetails(details) ⇒ NavigationInstruction

Set the Details

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

ParamTypeDescription
details String This is a string representation of this instruction, used to display instructions to - The desired Details. the users. This is not intended to be read aloud to the users, see the param prompt in NavigationServiceData for that.

navigationInstruction.setDrivingSide(side) ⇒ NavigationInstruction

Set the DrivingSide

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

ParamTypeDescription
side Direction Used to infer which side of the road this instruction takes place. For a U-Turn - The desired DrivingSide. (action=TURN, bearing=180) this will determine which direction the turn should take place.

navigationInstruction.setEta(eta) ⇒ NavigationInstruction

Set the Eta

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

ParamTypeDescription
eta DateTime The desired Eta.

navigationInstruction.setImage(image) ⇒ NavigationInstruction

Set the Image

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

ParamTypeDescription
image Image An image representation of this instruction. - The desired Image.

navigationInstruction.setJunctionType(type) ⇒ NavigationInstruction

Set the JunctionType

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

ParamTypeDescription
type NavigationJunction The desired JunctionType.

navigationInstruction.setLocationDetails(details) ⇒ NavigationInstruction

Set the LocationDetails

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

ParamTypeDescription
details LocationDetails The desired LocationDetails.
View on GitHub.com
Previous Section Next Section