User Tools

Site Tools

Trace: • thinkgeo.cloud.routingclient

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

api:thinkgeo.cloud.routingclient

Table of Contents

ThinkGeo.Cloud.RoutingClient

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.Cloud.BaseClient
      • ThinkGeo.Cloud.RoutingClient

Members Summary

Public Constructors

RoutingClient()

  • Initilizes an instance. You need apply client Id and secret by properties.
Remarks
  • N/A
Parameters

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

GetRoute(IEnumerable<PointShape>, RoutingGetRouteOptions)

  • Calculate a route through the specified waypoints.
Remarks
  • N/A
Return Value
Parameters
  • waypoints
    • Type:IEnumerable<PointShape>
    • Description:A list of coordinates to travel in order.

GetRoute(IEnumerable<PointShape>, Int32, RoutingGetRouteOptions)

  • Calculate a route through the specified waypoints.
Remarks
  • N/A
Return Value
Parameters
  • waypoints
    • Type:IEnumerable<PointShape>
    • Description:A list of coordinates to travel in order.
  • srid
    • Type:Int32
    • Description:Specifies the SRID (spatial reference system ID). Defaults to 4326.

GetRoute(IEnumerable<PointShape>, String, RoutingGetRouteOptions)

  • Calculate a route through the specified waypoints.
Remarks
  • N/A
Return Value
Parameters
  • waypoints
    • Type:IEnumerable<PointShape>
    • Description:A list of coordinates to travel in order.
  • proj4String
    • Type:String
    • Description:Specifies the proj4string (coordinate system).

GetRouteAsync(IEnumerable<PointShape>, RoutingGetRouteOptions)

  • Calculate a route through the specified waypoints.
Remarks
  • N/A
Return Value
Parameters
  • waypoints
    • Type:IEnumerable<PointShape>
    • Description:A list of coordinates to travel in order.

GetRouteAsync(IEnumerable<PointShape>, Int32, RoutingGetRouteOptions)

  • Calculate a route through the specified waypoints.
Remarks
  • N/A
Return Value
Parameters
  • waypoints
    • Type:IEnumerable<PointShape>
    • Description:A list of coordinates to travel in order.
  • srid
    • Type:Int32
    • Description:Specifies the SRID (spatial reference system ID). Defaults to 4326.

GetRouteAsync(IEnumerable<PointShape>, String, RoutingGetRouteOptions)

  • Calculate a route through the specified waypoints.
Remarks
  • N/A
Return Value
Parameters
  • waypoints
    • Type:IEnumerable<PointShape>
    • Description:A list of coordinates to travel in order.
  • proj4String
    • Type:String
    • Description:Specifies the proj4string (coordinate system).

GetServiceArea(PointShape, IEnumerable<Double>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • serviceLimits
    • Type:IEnumerable<Double>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceArea(PointShape, Int32, IEnumerable<Double>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • srid
    • Type:Int32
    • Description:Specifies the SRID (spatial reference system ID). Defaults to 4326.
  • serviceLimits
    • Type:IEnumerable<Double>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceArea(PointShape, String, IEnumerable<Double>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • proj4String
    • Type:String
    • Description:Specifies the proj4string (coordinate system).
  • serviceLimits
    • Type:IEnumerable<Double>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceArea(PointShape, IEnumerable<TimeSpan>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • serviceLimits
    • Type:IEnumerable<TimeSpan>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceArea(PointShape, Int32, IEnumerable<TimeSpan>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • srid
    • Type:Int32
    • Description:Specifies the SRID (spatial reference system ID). Defaults to 4326.
  • serviceLimits
    • Type:IEnumerable<TimeSpan>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceArea(PointShape, String, IEnumerable<TimeSpan>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • proj4String
    • Type:String
    • Description:Specifies the proj4string (coordinate system).
  • serviceLimits
    • Type:IEnumerable<TimeSpan>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceAreaAsync(PointShape, IEnumerable<Double>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • serviceLimits
    • Type:IEnumerable<Double>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceAreaAsync(PointShape, Int32, IEnumerable<Double>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • srid
    • Type:Int32
    • Description:Specifies the SRID (spatial reference system ID). Defaults to 4326.
  • serviceLimits
    • Type:IEnumerable<Double>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceAreaAsync(PointShape, String, IEnumerable<Double>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • proj4String
    • Type:String
    • Description:Specifies the proj4string (coordinate system).
  • serviceLimits
    • Type:IEnumerable<Double>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceAreaAsync(PointShape, IEnumerable<TimeSpan>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • serviceLimits
    • Type:IEnumerable<TimeSpan>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceAreaAsync(PointShape, Int32, IEnumerable<TimeSpan>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • srid
    • Type:Int32
    • Description:Specifies the SRID (spatial reference system ID). Defaults to 4326.
  • serviceLimits
    • Type:IEnumerable<TimeSpan>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

GetServiceAreaAsync(PointShape, String, IEnumerable<TimeSpan>, RoutingGetServiceAreaOptions)

  • Calculate the ServiceArea through the specified point.
Remarks
  • N/A
Return Value
Parameters
  • proj4String
    • Type:String
    • Description:Specifies the proj4string (coordinate system).
  • serviceLimits
    • Type:IEnumerable<TimeSpan>
    • Description:The list represents the travel distances or travel times to generate for each facility. The maximum number of ServiceLimits is 6.

Dispose()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

AuthenticateWebRequest(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

GetToken()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

GetTokenCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

SendWebRequest(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:WebResponse
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

SendWebRequestAsync(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Task<WebResponse>
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

GetNextCandidateBaseUri()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

GetNextCandidateBaseUriCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

OnGettingAccessToken(GettingAccessTokenEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnSendingWebRequest(SendingWebRequestEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnSentWebRequest(SentWebRequestEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

TimeoutInSeconds

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

WebProxy

  • N/A
Remarks
  • N/A
Return Value
  • Type:IWebProxy

ClientId

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

ClientSecret

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

BaseUris

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Uri>

Protected Properties

Public Events

GettingAccessToken

  • N/A
Remarks
  • N/A

Event Arguments:GettingAccessTokenEventArgs

SendingWebRequest

  • N/A
Remarks
  • N/A

Event Arguments:SendingWebRequestEventArgs

SentWebRequest

  • N/A
Remarks
  • N/A

Event Arguments:SentWebRequestEventArgs

api/thinkgeo.cloud.routingclient.txt · Last modified: 2019/06/27 05:14 by kevinwan

Page Tools