C# Class IO.Swagger.Api.SpecialApi

Represents a collection of functions to interact with the API endpoints

Inheritance: ISpecialApi

Exibir arquivo Open project: TNOCS/csTouch

Public Methods

Method	Description
Bbox ( float swlng, float swlat, float nelng, float nelat, string layerId ) : void	Gets all and any points in a (bounding box) rectangle. Takes two lng/lat pairs as input. These MUST be the south-west (bottom left) and northeast (top right) coordinates expressed as floating point numbers.
BboxAsync ( float swlng, float swlat, float nelng, float nelat, string layerId ) : System.Threading.Tasks.Task	Gets all and any points in a (bounding box) rectangle. Takes two lng/lat pairs as input. These MUST be the south-west (bottom left) and northeast (top right) coordinates expressed as floating point numbers.
GetBasePath ( ) : String	Gets the base path of the API client.
Getsphere ( float lng, float lat, float distance, string layerId ) : void	Gets all and any points in a sphere defined by its center coordinate. takes the center coordinate (Lat:lng) and distance (radius) as arguments to provide a list of coordinates starting with the closest coordinates to the center.
GetsphereAsync ( float lng, float lat, float distance, string layerId ) : System.Threading.Tasks.Task	Gets all and any points in a sphere defined by its center coordinate. takes the center coordinate (Lat:lng) and distance (radius) as arguments to provide a list of coordinates starting with the closest coordinates to the center.
Getwithinpolygon ( Feature feature, string layerId ) : void	Gets all and any points that are within a user-supplied polygon in a GeoJSON document. Takes a GeoJSON specification compliant document as input. This method can be used to determine the points within a special area, such as municipial borders.
GetwithinpolygonAsync ( Feature feature, string layerId ) : System.Threading.Tasks.Task	Gets all and any points that are within a user-supplied polygon in a GeoJSON document. Takes a GeoJSON specification compliant document as input. This method can be used to determine the points within a special area, such as municipial borders.
SetBasePath ( String basePath ) : void	Sets the base path of the API client.
SpecialApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the SpecialApi class.
SpecialApi ( String basePath ) : System	Initializes a new instance of the SpecialApi class.

Method Details

Bbox() public method

Gets all and any points in a (bounding box) rectangle. Takes two lng/lat pairs as input. These MUST be the south-west (bottom left) and northeast (top right) coordinates expressed as floating point numbers.

public Bbox ( float swlng, float swlat, float nelng, float nelat, string layerId ) : void
swlng	float	Southwestern longtitude used to calculate the bbox
swlat	float	Southwestern latitude used to calculate the bbox
nelng	float	Northeastern longtitude used to calculate the bbox
nelat	float	Northeastern latitude used to calculate the bbox
layerId	string	ID of the layer
return	void

BboxAsync() public method

public BboxAsync ( float swlng, float swlat, float nelng, float nelat, string layerId ) : System.Threading.Tasks.Task
swlng	float	Southwestern longtitude used to calculate the bbox
swlat	float	Southwestern latitude used to calculate the bbox
nelng	float	Northeastern longtitude used to calculate the bbox
nelat	float	Northeastern latitude used to calculate the bbox
layerId	string	ID of the layer
return	System.Threading.Tasks.Task

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String

Getsphere() public method

Gets all and any points in a sphere defined by its center coordinate. takes the center coordinate (Lat:lng) and distance (radius) as arguments to provide a list of coordinates starting with the closest coordinates to the center.

public Getsphere ( float lng, float lat, float distance, string layerId ) : void
lng	float	Longtitude used to calculate the sphere
lat	float	Latitude used to calculate the sphere
distance	float	Max distane in meters
layerId	string	ID of the layer
return	void

GetsphereAsync() public method

public GetsphereAsync ( float lng, float lat, float distance, string layerId ) : System.Threading.Tasks.Task
lng	float	Longtitude used to calculate the sphere
lat	float	Latitude used to calculate the sphere
distance	float	Max distane in meters
layerId	string	ID of the layer
return	System.Threading.Tasks.Task

Getwithinpolygon() public method

Gets all and any points that are within a user-supplied polygon in a GeoJSON document. Takes a GeoJSON specification compliant document as input. This method can be used to determine the points within a special area, such as municipial borders.

public Getwithinpolygon ( Feature feature, string layerId ) : void
feature	IO.Swagger.Model.Feature	JSON that will be used to query the layer
layerId	string	ID of the layer
return	void

GetwithinpolygonAsync() public method

public GetwithinpolygonAsync ( Feature feature, string layerId ) : System.Threading.Tasks.Task
feature	IO.Swagger.Model.Feature	JSON that will be used to query the layer
layerId	string	ID of the layer
return	System.Threading.Tasks.Task

SetBasePath() public method

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String	The base path
return	void

SpecialApi() public method

Initializes a new instance of the SpecialApi class.

public SpecialApi ( ApiClient apiClient = null ) : System
apiClient	IO.Swagger.Client.ApiClient	an instance of ApiClient (optional)
return	System

SpecialApi() public method

Initializes a new instance of the SpecialApi class.

public SpecialApi ( String basePath ) : System
basePath	String
return	System