====== ThinkGeo.Cloud.RoutingClient ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.Cloud.BaseClient ***ThinkGeo.Cloud.RoutingClient** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} RoutingClient() ** * //Initilizes an instance. You need apply client Id and secret by properties.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} RoutingClient(String,String) ** * //Initializes an instance with ClientID and ClientSecret. It will send a request to GIS Server to gain the token which will be added to the Header for all the requests.// == Remarks == * //N/A// == Parameters == * //clientId// * Type:String * Description:The ClientID for the auth. * //clientSecret// * Type:String * Description:The ClientSecret for the auth.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} GetRoute(IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]>, [[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]]) ** * Calculate a route through the specified waypoints. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetRouteResult|RoutingGetRouteResult]] * Description://N/A// == Parameters == * //waypoints// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]> * Description:A list of coordinates to travel in order. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]] * Description:The options for the GetRoute.
** {{wiki:PublicMethod.gif|}} GetRoute(IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]>, Int32, [[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]]) ** * Calculate a route through the specified waypoints. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetRouteResult|RoutingGetRouteResult]] * Description://N/A// == Parameters == * //waypoints// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]> * Description:A list of coordinates to travel in order. * //srid// * Type:Int32 * Description:Specifies the SRID (spatial reference system ID). Defaults to 4326. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]] * Description:The options for the GetRoute.
** {{wiki:PublicMethod.gif|}} GetRoute(IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]>, String, [[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]]) ** * Calculate a route through the specified waypoints. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetRouteResult|RoutingGetRouteResult]] * Description://N/A// == Parameters == * //waypoints// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]> * Description:A list of coordinates to travel in order. * //proj4String// * Type:String * Description:Specifies the proj4string (coordinate system). * //options// * Type:[[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]] * Description:The options for the GetRoute.
** {{wiki:PublicMethod.gif|}} GetRouteAsync(IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]>, [[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]]) ** * Calculate a route through the specified waypoints. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetRouteResult|RoutingGetRouteResult]]> * Description://N/A// == Parameters == * //waypoints// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]> * Description:A list of coordinates to travel in order. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]] * Description:The options for the GetRoute.
** {{wiki:PublicMethod.gif|}} GetRouteAsync(IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]>, Int32, [[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]]) ** * Calculate a route through the specified waypoints. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetRouteResult|RoutingGetRouteResult]]> * Description://N/A// == Parameters == * //waypoints// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]> * Description:A list of coordinates to travel in order. * //srid// * Type:Int32 * Description:Specifies the SRID (spatial reference system ID). Defaults to 4326. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]] * Description:The options for the GetRoute.
** {{wiki:PublicMethod.gif|}} GetRouteAsync(IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]>, String, [[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]]) ** * Calculate a route through the specified waypoints. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetRouteResult|RoutingGetRouteResult]]> * Description://N/A// == Parameters == * //waypoints// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]]> * Description:A list of coordinates to travel in order. * //proj4String// * Type:String * Description:Specifies the proj4string (coordinate system). * //options// * Type:[[ThinkGeo.Cloud.RoutingGetRouteOptions|RoutingGetRouteOptions]] * Description:The options for the GetRoute.
** {{wiki:PublicMethod.gif|}} GetServiceArea([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]] * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceArea([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], Int32, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]] * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //srid// * Type:Int32 * Description:Specifies the SRID (spatial reference system ID). Defaults to 4326. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceArea([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], String, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]] * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //proj4String// * Type:String * Description:Specifies the proj4string (coordinate system). * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceArea([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]] * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceArea([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], Int32, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]] * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //srid// * Type:Int32 * Description:Specifies the SRID (spatial reference system ID). Defaults to 4326. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceArea([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], String, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]] * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //proj4String// * Type:String * Description:Specifies the proj4string (coordinate system). * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceAreaAsync([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]]> * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceAreaAsync([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], Int32, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]]> * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //srid// * Type:Int32 * Description:Specifies the SRID (spatial reference system ID). Defaults to 4326. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceAreaAsync([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], String, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]]> * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //proj4String// * Type:String * Description:Specifies the proj4string (coordinate system). * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceAreaAsync([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]]> * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceAreaAsync([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], Int32, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]]> * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //srid// * Type:Int32 * Description:Specifies the SRID (spatial reference system ID). Defaults to 4326. * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} GetServiceAreaAsync([[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]], String, IEnumerable, [[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]]) ** * Calculate the ServiceArea through the specified point. == Remarks == * //N/A// == Return Value == * Type:Task<[[ThinkGeo.Cloud.RoutingGetServiceAreaResult|RoutingGetServiceAreaResult]]> * Description://N/A// == Parameters == * //points// * Type:[[ThinkGeo.MapSuite.Shapes.PointShape|PointShape]] * Description:The point. * //proj4String// * Type:String * Description:Specifies the proj4string (coordinate system). * //serviceLimits// * Type:IEnumerable * Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6. * //options// * Type:[[ThinkGeo.Cloud.RoutingGetServiceAreaOptions|RoutingGetServiceAreaOptions]] * Description:The options for the GetServiceArea.
** {{wiki:PublicMethod.gif|}} Dispose() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} AuthenticateWebRequest(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //webRequest// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetToken() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetTokenCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:WebResponse * Description:N/A == Parameters == * //webRequest// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} SendWebRequestAsync(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Task * Description:N/A == Parameters == * //webRequest// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetNextCandidateBaseUri() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetNextCandidateBaseUriCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OnGettingAccessToken(GettingAccessTokenEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Cloud.GettingAccessTokenEventArgs|GettingAccessTokenEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.SentWebRequestEventArgs|SentWebRequestEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} TimeoutInSeconds ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} WebProxy ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:IWebProxy ** {{wiki:PublicProperty.gif|}} ClientId ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} ClientSecret ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} BaseUris ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection ==== Protected Properties ==== ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} GettingAccessToken ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Cloud.GettingAccessTokenEventArgs|GettingAccessTokenEventArgs]] ** {{wiki:PublicEvent.gif|}} SendingWebRequest ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] ** {{wiki:PublicEvent.gif|}} SentWebRequest ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.SentWebRequestEventArgs|SentWebRequestEventArgs]]