NavigationInstruction Class Reference
Constructors
Instance Methods
- getAction() ⇒
NavigationAction - getBearing() ⇒
Number - getDetails() ⇒
String - getDrivingSide() ⇒
Direction - getEta() ⇒
DateTime - getImage() ⇒
Image - getJunctionType() ⇒
NavigationJunction - getLocationDetails() ⇒
LocationDetails - setAction(action) ⇒
NavigationInstruction - setBearing(bearing) ⇒
NavigationInstruction - setDetails(details) ⇒
NavigationInstruction - setDrivingSide(side) ⇒
NavigationInstruction - setEta(eta) ⇒
NavigationInstruction - setImage(image) ⇒
NavigationInstruction - setJunctionType(type) ⇒
NavigationInstruction - setLocationDetails(details) ⇒
NavigationInstruction
Constructors
new NavigationInstruction(parameters)
Initializes 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| bearing | Number |
The angle at which this instruction takes place. For example, 0 would mean straight, 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. - The desired Bearing. {'num_min_value': 0, 'num_max_value': 359} |
navigationInstruction.setDetails(details) ⇒ NavigationInstruction
Set the Details
Kind: Instance method of NavigationInstruction
Returns: NavigationInstruction - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| details | String |
This is a string representation of this instruction, used to display instructions to the users. This is not intended to be read aloud to the users, see the param prompt in NavigationServiceData for that. - The desired Details. {'string_min_length': 1} |
navigationInstruction.setDrivingSide(side) ⇒ NavigationInstruction
Set the DrivingSide
Kind: Instance method of NavigationInstruction
Returns: NavigationInstruction - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| side | Direction |
Used to infer which side of the road this instruction takes place. For a U-Turn (action=TURN, bearing=180) this will determine which direction the turn should take place. - The desired DrivingSide. |
navigationInstruction.setEta(eta) ⇒ NavigationInstruction
Set the Eta
Kind: Instance method of NavigationInstruction
Returns: NavigationInstruction - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| image | Image |
An image representation of this instruction. - The desired Image. |