Online Maps  v3
OnlineMapsGoogleDirections.Params Class Reference

Request parameters. More...

Public Member Functions

 Params (object origin, object destination)
 Constructor More...
 

Public Attributes

object origin
 The address (string), coordinates (Vector2, OnlineMapsVector2d), or place ID (string prefixed with place_id:) from which you wish to calculate directions. More...
 
object destination
 The address (string), coordinates (Vector2, OnlineMapsVector2d), or place ID (string prefixed with place_id:) to which you wish to calculate directions. More...
 
Modemode
 Specifies the mode of transport to use when calculating directions. Default: driving. More...
 
IEnumerable waypoints
 Specifies an IEnumerate of waypoints. Waypoints alter a route by routing it through the specified location(s).
The maximum number of waypoints is 8.
Each waypoint can be specified as a coordinates (Vector2, OnlineMapsVector2d), an encoded polyline (string prefixed with enc:), a place ID (string prefixed with place_id:), or an address which will be geocoded. More...
 
bool alternatives
 If set to true, specifies that the Directions service may provide more than one route alternative in the response.
Note that providing route alternatives may increase the response time from the server. More...
 
Avoidavoid
 Indicates that the calculated route(s) should avoid the indicated features. More...
 
Unitsunits
 Specifies the unit system to use when displaying results. More...
 
string region
 Specifies the region code, specified as a ccTLD ("top-level domain") two-character value. More...
 
long? arrival_time
 Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC.
You can specify either departure_time or arrival_time, but not both. More...
 
string language
 Specifies the language in which to return results. More...
 
string key
 Your application's API key. This key identifies your application for purposes of quota management. More...
 
TrafficModeltraffic_model
 Specifies the assumptions to use when calculating time in traffic. More...
 
TransitModetransit_mode
 Specifies one or more preferred modes of transit. This parameter may only be specified for transit directions. More...
 
TransitRoutingPreferencetransit_routing_preference
 Specifies preferences for transit routes. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API.
This parameter may only be specified for transit directions. More...
 

Properties

object departure_time [get, set]
 Specifies the desired time of departure. You can specify the time as an integer in seconds since midnight, January 1, 1970 UTC.
Alternatively, you can specify a value of now, which sets the departure time to the current time. More...
 

Detailed Description

Request parameters.

Constructor & Destructor Documentation

◆ Params()

OnlineMapsGoogleDirections.Params.Params ( object  origin,
object  destination 
)

Constructor

Parameters
originThe address (string), coordinates (Vector2, OnlineMapsVector2d), or place ID (string prefixed with place_id:) from which you wish to calculate directions.
destinationThe address (string), coordinates (Vector2, OnlineMapsVector2d), or place ID (string prefixed with place_id:) to which you wish to calculate directions.

Member Data Documentation

◆ alternatives

bool OnlineMapsGoogleDirections.Params.alternatives

If set to true, specifies that the Directions service may provide more than one route alternative in the response.
Note that providing route alternatives may increase the response time from the server.

◆ arrival_time

long? OnlineMapsGoogleDirections.Params.arrival_time

Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC.
You can specify either departure_time or arrival_time, but not both.

◆ avoid

Avoid? OnlineMapsGoogleDirections.Params.avoid

Indicates that the calculated route(s) should avoid the indicated features.

◆ destination

object OnlineMapsGoogleDirections.Params.destination

The address (string), coordinates (Vector2, OnlineMapsVector2d), or place ID (string prefixed with place_id:) to which you wish to calculate directions.

◆ key

string OnlineMapsGoogleDirections.Params.key

Your application's API key. This key identifies your application for purposes of quota management.

◆ language

string OnlineMapsGoogleDirections.Params.language

Specifies the language in which to return results.

◆ mode

Mode? OnlineMapsGoogleDirections.Params.mode

Specifies the mode of transport to use when calculating directions. Default: driving.

◆ origin

object OnlineMapsGoogleDirections.Params.origin

The address (string), coordinates (Vector2, OnlineMapsVector2d), or place ID (string prefixed with place_id:) from which you wish to calculate directions.

◆ region

string OnlineMapsGoogleDirections.Params.region

Specifies the region code, specified as a ccTLD ("top-level domain") two-character value.

◆ traffic_model

TrafficModel? OnlineMapsGoogleDirections.Params.traffic_model

Specifies the assumptions to use when calculating time in traffic.

◆ transit_mode

TransitMode? OnlineMapsGoogleDirections.Params.transit_mode

Specifies one or more preferred modes of transit. This parameter may only be specified for transit directions.

◆ transit_routing_preference

TransitRoutingPreference? OnlineMapsGoogleDirections.Params.transit_routing_preference

Specifies preferences for transit routes. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API.
This parameter may only be specified for transit directions.

◆ units

Units? OnlineMapsGoogleDirections.Params.units

Specifies the unit system to use when displaying results.

◆ waypoints

IEnumerable OnlineMapsGoogleDirections.Params.waypoints

Specifies an IEnumerate of waypoints. Waypoints alter a route by routing it through the specified location(s).
The maximum number of waypoints is 8.
Each waypoint can be specified as a coordinates (Vector2, OnlineMapsVector2d), an encoded polyline (string prefixed with enc:), a place ID (string prefixed with place_id:), or an address which will be geocoded.

Property Documentation

◆ departure_time

object OnlineMapsGoogleDirections.Params.departure_time
getset

Specifies the desired time of departure. You can specify the time as an integer in seconds since midnight, January 1, 1970 UTC.
Alternatively, you can specify a value of now, which sets the departure time to the current time.