CoreTweet  2.0.0-beta.2
Yet another .NET Twitter Library
Public Member Functions | List of all members
CoreTweet.Rest.Geo Class Reference

Provides a set of methods for the wrapper of GET/POST geo. More...

Inheritance diagram for CoreTweet.Rest.Geo:
CoreTweet.Core.ApiProviderBase

Public Member Functions

PlaceResponse Id (params Expression< Func< string, object >>[] parameters)
 
PlaceResponse Id (IDictionary< string, object > parameters)
 
PlaceResponse Id (object parameters)
 
PlaceResponse Id (string place_id)
 
Task< PlaceResponseIdAsync (params Expression< Func< string, object >>[] parameters)
 
Task< PlaceResponseIdAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< PlaceResponseIdAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< PlaceResponseIdAsync (string place_id, CancellationToken cancellationToken=default(CancellationToken))
 
GeoResult SimilarPlaces (params Expression< Func< string, object >>[] parameters)
 
GeoResult SimilarPlaces (IDictionary< string, object > parameters)
 
GeoResult SimilarPlaces (object parameters)
 
GeoResult SimilarPlaces (double lat, double @long, string name, string contained_within=null, string street_address=null)
 
Task< GeoResultSimilarPlacesAsync (params Expression< Func< string, object >>[] parameters)
 
Task< GeoResultSimilarPlacesAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< GeoResultSimilarPlacesAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< GeoResultSimilarPlacesAsync (double lat, double @long, string name, string contained_within=null, string street_address=null, CancellationToken cancellationToken=default(CancellationToken))
 
GeoResult Search (params Expression< Func< string, object >>[] parameters)
 
GeoResult Search (IDictionary< string, object > parameters)
 
GeoResult Search (object parameters)
 
GeoResult Search (double? lat=null, double? @long=null, string query=null, string ip=null, string granularity=null, string accuracy=null, int? max_results=null, string contained_within=null)
 
Task< GeoResultSearchAsync (params Expression< Func< string, object >>[] parameters)
 
Task< GeoResultSearchAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< GeoResultSearchAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< GeoResultSearchAsync (double? lat=null, double? @long=null, string query=null, string ip=null, string granularity=null, string accuracy=null, int? max_results=null, string contained_within=null, CancellationToken cancellationToken=default(CancellationToken))
 
GeoResult ReverseGeocode (params Expression< Func< string, object >>[] parameters)
 
GeoResult ReverseGeocode (IDictionary< string, object > parameters)
 
GeoResult ReverseGeocode (object parameters)
 
GeoResult ReverseGeocode (double lat, double @long, string accuracy=null, string granularity=null, int? max_results=null)
 
Task< GeoResultReverseGeocodeAsync (params Expression< Func< string, object >>[] parameters)
 
Task< GeoResultReverseGeocodeAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< GeoResultReverseGeocodeAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< GeoResultReverseGeocodeAsync (double lat, double @long, string accuracy=null, string granularity=null, int? max_results=null, CancellationToken cancellationToken=default(CancellationToken))
 

Additional Inherited Members

- Public Attributes inherited from CoreTweet.Core.ApiProviderBase
TokensBase IncludedTokens => this.Tokens
 Gets the tokens being used in this instance. More...
 
- Properties inherited from CoreTweet.Core.ApiProviderBase
TokensBase Tokens [get, set]
 Gets or sets the OAuth tokens. More...
 

Detailed Description

Provides a set of methods for the wrapper of GET/POST geo.

Member Function Documentation

◆ Id() [1/4]

PlaceResponse CoreTweet.Rest.Geo.Id ( IDictionary< string, object >  parameters)
inline

Returns all the information about a known place.

Available parameters:

- string place_id (required)

Parameters
parametersThe parameters.
Returns
The place.

◆ Id() [2/4]

PlaceResponse CoreTweet.Rest.Geo.Id ( object  parameters)
inline

Returns all the information about a known place.

Available parameters:

- string place_id (required)

Parameters
parametersThe parameters.
Returns
The place.

◆ Id() [3/4]

PlaceResponse CoreTweet.Rest.Geo.Id ( params Expression< Func< string, object >>[]  parameters)
inline

Returns all the information about a known place.

Available parameters:

- string place_id (required)

Parameters
parametersThe parameters.
Returns
The place.

◆ Id() [4/4]

PlaceResponse CoreTweet.Rest.Geo.Id ( string  place_id)
inline

Returns all the information about a known place.

Parameters
place_idrequired.
Returns
The place.

◆ IdAsync() [1/4]

Task<PlaceResponse> CoreTweet.Rest.Geo.IdAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns all the information about a known place.

Available parameters:

- string place_id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The place.

◆ IdAsync() [2/4]

Task<PlaceResponse> CoreTweet.Rest.Geo.IdAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns all the information about a known place.

Available parameters:

- string place_id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The place.

◆ IdAsync() [3/4]

Task<PlaceResponse> CoreTweet.Rest.Geo.IdAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns all the information about a known place.

Available parameters:

- string place_id (required)

Parameters
parametersThe parameters.
Returns
The place.

◆ IdAsync() [4/4]

Task<PlaceResponse> CoreTweet.Rest.Geo.IdAsync ( string  place_id,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns all the information about a known place.

Parameters
place_idrequired.
cancellationTokenThe cancellation token.
Returns
The place.

◆ ReverseGeocode() [1/4]

GeoResult CoreTweet.Rest.Geo.ReverseGeocode ( double  lat,
double @ long  ,
string  accuracy = null,
string  granularity = null,
int?  max_results = null 
)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Parameters
latrequired.
longrequired.
accuracyoptional.
granularityoptional.
max_resultsoptional.
Returns
Places.

◆ ReverseGeocode() [2/4]

GeoResult CoreTweet.Rest.Geo.ReverseGeocode ( IDictionary< string, object >  parameters)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Available parameters:

- double lat (required)

- double long (required)

- string accuracy (optional)

- string granularity (optional)

- int max_results (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ ReverseGeocode() [3/4]

GeoResult CoreTweet.Rest.Geo.ReverseGeocode ( object  parameters)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Available parameters:

- double lat (required)

- double long (required)

- string accuracy (optional)

- string granularity (optional)

- int max_results (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ ReverseGeocode() [4/4]

GeoResult CoreTweet.Rest.Geo.ReverseGeocode ( params Expression< Func< string, object >>[]  parameters)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Available parameters:

- double lat (required)

- double long (required)

- string accuracy (optional)

- string granularity (optional)

- int max_results (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ ReverseGeocodeAsync() [1/4]

Task<GeoResult> CoreTweet.Rest.Geo.ReverseGeocodeAsync ( double  lat,
double @ long  ,
string  accuracy = null,
string  granularity = null,
int?  max_results = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Parameters
latrequired.
longrequired.
accuracyoptional.
granularityoptional.
max_resultsoptional.
cancellationTokenThe cancellation token.
Returns
Places.

◆ ReverseGeocodeAsync() [2/4]

Task<GeoResult> CoreTweet.Rest.Geo.ReverseGeocodeAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Available parameters:

- double lat (required)

- double long (required)

- string accuracy (optional)

- string granularity (optional)

- int max_results (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
Places.

◆ ReverseGeocodeAsync() [3/4]

Task<GeoResult> CoreTweet.Rest.Geo.ReverseGeocodeAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Available parameters:

- double lat (required)

- double long (required)

- string accuracy (optional)

- string granularity (optional)

- int max_results (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
Places.

◆ ReverseGeocodeAsync() [4/4]

Task<GeoResult> CoreTweet.Rest.Geo.ReverseGeocodeAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.

This request is an informative call and will deliver generalized results about geography.

Available parameters:

- double lat (required)

- double long (required)

- string accuracy (optional)

- string granularity (optional)

- int max_results (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ Search() [1/4]

GeoResult CoreTweet.Rest.Geo.Search ( double?  lat = null,
double? @ long  = null,
string  query = null,
string  ip = null,
string  granularity = null,
string  accuracy = null,
int?  max_results = null,
string  contained_within = null 
)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Parameters
latoptional.
longoptional.
queryoptional.
ipoptional.
granularityoptional.
accuracyoptional.
max_resultsoptional.
contained_withinoptional.
Returns
Places.

◆ Search() [2/4]

GeoResult CoreTweet.Rest.Geo.Search ( IDictionary< string, object >  parameters)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Available parameters:

- double lat (optional)

- double long (optional)

- string query (optional)

- string ip (optional)

- string granularity (optional)

- string accuracy (optional)

- int max_results (optional)

- string contained_within (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ Search() [3/4]

GeoResult CoreTweet.Rest.Geo.Search ( object  parameters)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Available parameters:

- double lat (optional)

- double long (optional)

- string query (optional)

- string ip (optional)

- string granularity (optional)

- string accuracy (optional)

- int max_results (optional)

- string contained_within (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ Search() [4/4]

GeoResult CoreTweet.Rest.Geo.Search ( params Expression< Func< string, object >>[]  parameters)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Available parameters:

- double lat (optional)

- double long (optional)

- string query (optional)

- string ip (optional)

- string granularity (optional)

- string accuracy (optional)

- int max_results (optional)

- string contained_within (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ SearchAsync() [1/4]

Task<GeoResult> CoreTweet.Rest.Geo.SearchAsync ( double?  lat = null,
double? @ long  = null,
string  query = null,
string  ip = null,
string  granularity = null,
string  accuracy = null,
int?  max_results = null,
string  contained_within = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Parameters
latoptional.
longoptional.
queryoptional.
ipoptional.
granularityoptional.
accuracyoptional.
max_resultsoptional.
contained_withinoptional.
cancellationTokenThe cancellation token.
Returns
Places.

◆ SearchAsync() [2/4]

Task<GeoResult> CoreTweet.Rest.Geo.SearchAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Available parameters:

- double lat (optional)

- double long (optional)

- string query (optional)

- string ip (optional)

- string granularity (optional)

- string accuracy (optional)

- int max_results (optional)

- string contained_within (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
Places.

◆ SearchAsync() [3/4]

Task<GeoResult> CoreTweet.Rest.Geo.SearchAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Available parameters:

- double lat (optional)

- double long (optional)

- string query (optional)

- string ip (optional)

- string granularity (optional)

- string accuracy (optional)

- int max_results (optional)

- string contained_within (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
Places.

◆ SearchAsync() [4/4]

Task<GeoResult> CoreTweet.Rest.Geo.SearchAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Search for places that can be attached to a statuses/update.

Note: At least one of the following parameters must be provided to this resource: lat, long, ip, or query

Available parameters:

- double lat (optional)

- double long (optional)

- string query (optional)

- string ip (optional)

- string granularity (optional)

- string accuracy (optional)

- int max_results (optional)

- string contained_within (optional)

Parameters
parametersThe parameters.
Returns
Places.

◆ SimilarPlaces() [1/4]

GeoResult CoreTweet.Rest.Geo.SimilarPlaces ( double  lat,
double @ long  ,
string  name,
string  contained_within = null,
string  street_address = null 
)
inline

Locates places near the given coordinates which are similar in name.

Parameters
latrequired.
longrequired.
namerequired.
contained_withinoptional.
street_addressoptional.
Returns
Places and the token

◆ SimilarPlaces() [2/4]

GeoResult CoreTweet.Rest.Geo.SimilarPlaces ( IDictionary< string, object >  parameters)
inline

Locates places near the given coordinates which are similar in name.

Available parameters:

- double lat (required)

- double long (required)

- string name (required)

- string contained_within (optional)

- string street_address (optional)

Parameters
parametersThe parameters.
Returns
Places and the token

◆ SimilarPlaces() [3/4]

GeoResult CoreTweet.Rest.Geo.SimilarPlaces ( object  parameters)
inline

Locates places near the given coordinates which are similar in name.

Available parameters:

- double lat (required)

- double long (required)

- string name (required)

- string contained_within (optional)

- string street_address (optional)

Parameters
parametersThe parameters.
Returns
Places and the token

◆ SimilarPlaces() [4/4]

GeoResult CoreTweet.Rest.Geo.SimilarPlaces ( params Expression< Func< string, object >>[]  parameters)
inline

Locates places near the given coordinates which are similar in name.

Available parameters:

- double lat (required)

- double long (required)

- string name (required)

- string contained_within (optional)

- string street_address (optional)

Parameters
parametersThe parameters.
Returns
Places and the token

◆ SimilarPlacesAsync() [1/4]

Task<GeoResult> CoreTweet.Rest.Geo.SimilarPlacesAsync ( double  lat,
double @ long  ,
string  name,
string  contained_within = null,
string  street_address = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Locates places near the given coordinates which are similar in name.

Parameters
latrequired.
longrequired.
namerequired.
contained_withinoptional.
street_addressoptional.
cancellationTokenThe cancellation token.
Returns
Places and the token

◆ SimilarPlacesAsync() [2/4]

Task<GeoResult> CoreTweet.Rest.Geo.SimilarPlacesAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Locates places near the given coordinates which are similar in name.

Available parameters:

- double lat (required)

- double long (required)

- string name (required)

- string contained_within (optional)

- string street_address (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
Places and the token

◆ SimilarPlacesAsync() [3/4]

Task<GeoResult> CoreTweet.Rest.Geo.SimilarPlacesAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Locates places near the given coordinates which are similar in name.

Available parameters:

- double lat (required)

- double long (required)

- string name (required)

- string contained_within (optional)

- string street_address (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
Places and the token

◆ SimilarPlacesAsync() [4/4]

Task<GeoResult> CoreTweet.Rest.Geo.SimilarPlacesAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Locates places near the given coordinates which are similar in name.

Available parameters:

- double lat (required)

- double long (required)

- string name (required)

- string contained_within (optional)

- string street_address (optional)

Parameters
parametersThe parameters.
Returns
Places and the token

The documentation for this class was generated from the following file: