CoreTweet.Rest.Help Class Reference

Provides a set of methods for the wrapper of GET help. More...

Inheritance diagram for CoreTweet.Rest.Help:

Public Member Functions
Configurations	Configuration (params Expression< Func< string, object >>[] parameters)
Configurations	Configuration (IDictionary< string, object > parameters)
Configurations	Configuration (object parameters)
Configurations	Configuration ()
Task< Configurations >	ConfigurationAsync (params Expression< Func< string, object >>[] parameters)
Task< Configurations >	ConfigurationAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< Configurations >	ConfigurationAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< Configurations >	ConfigurationAsync (CancellationToken cancellationToken=default(CancellationToken))
ListedResponse< Language >	Languages (params Expression< Func< string, object >>[] parameters)
ListedResponse< Language >	Languages (IDictionary< string, object > parameters)
ListedResponse< Language >	Languages (object parameters)
ListedResponse< Language >	Languages ()
Task< ListedResponse< Language > >	LanguagesAsync (params Expression< Func< string, object >>[] parameters)
Task< ListedResponse< Language > >	LanguagesAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< ListedResponse< Language > >	LanguagesAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< ListedResponse< Language > >	LanguagesAsync (CancellationToken cancellationToken=default(CancellationToken))
StringResponse	Privacy (params Expression< Func< string, object >>[] parameters)
StringResponse	Privacy (IDictionary< string, object > parameters)
StringResponse	Privacy (object parameters)
StringResponse	Privacy ()
Task< StringResponse >	PrivacyAsync (params Expression< Func< string, object >>[] parameters)
Task< StringResponse >	PrivacyAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< StringResponse >	PrivacyAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< StringResponse >	PrivacyAsync (CancellationToken cancellationToken=default(CancellationToken))
StringResponse	Tos (params Expression< Func< string, object >>[] parameters)
StringResponse	Tos (IDictionary< string, object > parameters)
StringResponse	Tos (object parameters)
StringResponse	Tos ()
Task< StringResponse >	TosAsync (params Expression< Func< string, object >>[] parameters)
Task< StringResponse >	TosAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< StringResponse >	TosAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< StringResponse >	TosAsync (CancellationToken cancellationToken=default(CancellationToken))
DictionaryResponse< string, Dictionary< string, RateLimit > >	RateLimitStatus (params Expression< Func< string, object >>[] parameters)
DictionaryResponse< string, Dictionary< string, RateLimit > >	RateLimitStatus (IDictionary< string, object > parameters)
DictionaryResponse< string, Dictionary< string, RateLimit > >	RateLimitStatus (object parameters)
DictionaryResponse< string, Dictionary< string, RateLimit > >	RateLimitStatus ()
DictionaryResponse< string, Dictionary< string, RateLimit > >	RateLimitStatus (string resources)
DictionaryResponse< string, Dictionary< string, RateLimit > >	RateLimitStatus (IEnumerable< string > resources)
Task< DictionaryResponse< string, Dictionary< string, RateLimit > > >	RateLimitStatusAsync (params Expression< Func< string, object >>[] parameters)
Task< DictionaryResponse< string, Dictionary< string, RateLimit > > >	RateLimitStatusAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< DictionaryResponse< string, Dictionary< string, RateLimit > > >	RateLimitStatusAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< DictionaryResponse< string, Dictionary< string, RateLimit > > >	RateLimitStatusAsync (CancellationToken cancellationToken=default(CancellationToken))
Task< DictionaryResponse< string, Dictionary< string, RateLimit > > >	RateLimitStatusAsync (string resources, CancellationToken cancellationToken=default(CancellationToken))
Task< DictionaryResponse< string, Dictionary< string, RateLimit > > >	RateLimitStatusAsync (IEnumerable< string > resources, 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 help.

Member Function Documentation

Configuration() [1/4]

Configurations CoreTweet.Rest.Help.Configuration ( )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Returns

Configurations.

Configuration() [2/4]

Configurations CoreTweet.Rest.Help.Configuration ( IDictionary< string, object >  parameters )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Configurations.

Configuration() [3/4]

Configurations CoreTweet.Rest.Help.Configuration ( object  parameters )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Configurations.

Configuration() [4/4]

Configurations CoreTweet.Rest.Help.Configuration ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Configurations.

ConfigurationAsync() [1/4]

Task<Configurations> CoreTweet.Rest.Help.ConfigurationAsync ( CancellationToken  cancellationToken = default(CancellationToken) )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Parameters

cancellationToken

The cancellation token.

Returns

Configurations.

ConfigurationAsync() [2/4]

Task<Configurations> CoreTweet.Rest.Help.ConfigurationAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

Configurations.

ConfigurationAsync() [3/4]

Task<Configurations> CoreTweet.Rest.Help.ConfigurationAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

Configurations.

ConfigurationAsync() [4/4]

Task<Configurations> CoreTweet.Rest.Help.ConfigurationAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Configurations.

Languages() [1/4]

ListedResponse<Language> CoreTweet.Rest.Help.Languages ( )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Returns

Languages.

Languages() [2/4]

ListedResponse<Language> CoreTweet.Rest.Help.Languages ( IDictionary< string, object >  parameters )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Languages.

Languages() [3/4]

ListedResponse<Language> CoreTweet.Rest.Help.Languages ( object  parameters )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Languages.

Languages() [4/4]

ListedResponse<Language> CoreTweet.Rest.Help.Languages ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Languages.

LanguagesAsync() [1/4]

Task<ListedResponse<Language> > CoreTweet.Rest.Help.LanguagesAsync ( CancellationToken  cancellationToken = default(CancellationToken) )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Parameters

cancellationToken

The cancellation token.

Returns

Languages.

LanguagesAsync() [2/4]

Task<ListedResponse<Language> > CoreTweet.Rest.Help.LanguagesAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

Languages.

LanguagesAsync() [3/4]

Task<ListedResponse<Language> > CoreTweet.Rest.Help.LanguagesAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

Languages.

LanguagesAsync() [4/4]

Task<ListedResponse<Language> > CoreTweet.Rest.Help.LanguagesAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the list of languages supported by Twitter along with the language code supported by Twitter.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

Languages.

Privacy() [1/4]

StringResponse CoreTweet.Rest.Help.Privacy ( )

inline

Returns Twitter’s Privacy Policy.

Returns

The sentense.

Privacy() [2/4]

StringResponse CoreTweet.Rest.Help.Privacy ( IDictionary< string, object >  parameters )

inline

Returns Twitter’s Privacy Policy.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

Privacy() [3/4]

StringResponse CoreTweet.Rest.Help.Privacy ( object  parameters )

inline

Returns Twitter’s Privacy Policy.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

Privacy() [4/4]

StringResponse CoreTweet.Rest.Help.Privacy ( params Expression< Func< string, object >>[]  parameters )

inline

Returns Twitter’s Privacy Policy.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

PrivacyAsync() [1/4]

Task<StringResponse> CoreTweet.Rest.Help.PrivacyAsync ( CancellationToken  cancellationToken = default(CancellationToken) )

inline

Returns Twitter’s Privacy Policy.

Parameters

cancellationToken

The cancellation token.

Returns

The sentense.

PrivacyAsync() [2/4]

Task<StringResponse> CoreTweet.Rest.Help.PrivacyAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns Twitter’s Privacy Policy.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The sentense.

PrivacyAsync() [3/4]

Task<StringResponse> CoreTweet.Rest.Help.PrivacyAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns Twitter’s Privacy Policy.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The sentense.

PrivacyAsync() [4/4]

Task<StringResponse> CoreTweet.Rest.Help.PrivacyAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Returns Twitter’s Privacy Policy.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

RateLimitStatus() [1/6]

DictionaryResponse<string, Dictionary<string,RateLimit> > CoreTweet.Rest.Help.RateLimitStatus ( )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Returns

RateLimitStatus() [2/6]

DictionaryResponse<string, Dictionary<string,RateLimit> > CoreTweet.Rest.Help.RateLimitStatus ( IDictionary< string, object >  parameters )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Available parameters:

- string resources (any one is required)

- IEnumerable<string> resources (any one is required)

Parameters

parameters

The parameters.

Returns

RateLimitStatus() [3/6]

DictionaryResponse<string, Dictionary<string,RateLimit> > CoreTweet.Rest.Help.RateLimitStatus ( IEnumerable< string >  resources )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Parameters

resources

any one is required.

Returns

RateLimitStatus() [4/6]

DictionaryResponse<string, Dictionary<string,RateLimit> > CoreTweet.Rest.Help.RateLimitStatus ( object  parameters )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Available parameters:

- string resources (any one is required)

- IEnumerable<string> resources (any one is required)

Parameters

parameters

The parameters.

Returns

RateLimitStatus() [5/6]

DictionaryResponse<string, Dictionary<string,RateLimit> > CoreTweet.Rest.Help.RateLimitStatus ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Available parameters:

- string resources (any one is required)

- IEnumerable<string> resources (any one is required)

Parameters

parameters

The parameters.

Returns

RateLimitStatus() [6/6]

DictionaryResponse<string, Dictionary<string,RateLimit> > CoreTweet.Rest.Help.RateLimitStatus ( string  resources )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Parameters

resources

any one is required.

Returns

RateLimitStatusAsync() [1/6]

Task<DictionaryResponse<string, Dictionary<string,RateLimit> > > CoreTweet.Rest.Help.RateLimitStatusAsync ( CancellationToken  cancellationToken = default(CancellationToken) )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Parameters

cancellationToken

The cancellation token.

Returns

RateLimitStatusAsync() [2/6]

Task<DictionaryResponse<string, Dictionary<string,RateLimit> > > CoreTweet.Rest.Help.RateLimitStatusAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Available parameters:

- string resources (any one is required)

- IEnumerable<string> resources (any one is required)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

RateLimitStatusAsync() [3/6]

Task<DictionaryResponse<string, Dictionary<string,RateLimit> > > CoreTweet.Rest.Help.RateLimitStatusAsync ( IEnumerable< string >  resources, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Parameters

resources	any one is required.
cancellationToken	The cancellation token.

Returns

RateLimitStatusAsync() [4/6]

Task<DictionaryResponse<string, Dictionary<string,RateLimit> > > CoreTweet.Rest.Help.RateLimitStatusAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Available parameters:

- string resources (any one is required)

- IEnumerable<string> resources (any one is required)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

RateLimitStatusAsync() [5/6]

Task<DictionaryResponse<string, Dictionary<string,RateLimit> > > CoreTweet.Rest.Help.RateLimitStatusAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Available parameters:

- string resources (any one is required)

- IEnumerable<string> resources (any one is required)

Parameters

parameters

The parameters.

Returns

RateLimitStatusAsync() [6/6]

Task<DictionaryResponse<string, Dictionary<string,RateLimit> > > CoreTweet.Rest.Help.RateLimitStatusAsync ( string  resources, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the current rate limits for methods belonging to the specified resource families.

Parameters

resources	any one is required.
cancellationToken	The cancellation token.

Returns

Tos() [1/4]

StringResponse CoreTweet.Rest.Help.Tos ( )

inline

Returns the Twitter Terms of Service.

Returns

The sentense.

Tos() [2/4]

StringResponse CoreTweet.Rest.Help.Tos ( IDictionary< string, object >  parameters )

inline

Returns the Twitter Terms of Service.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

Tos() [3/4]

StringResponse CoreTweet.Rest.Help.Tos ( object  parameters )

inline

Returns the Twitter Terms of Service.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

Tos() [4/4]

StringResponse CoreTweet.Rest.Help.Tos ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the Twitter Terms of Service.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

TosAsync() [1/4]

Task<StringResponse> CoreTweet.Rest.Help.TosAsync ( CancellationToken  cancellationToken = default(CancellationToken) )

inline

Returns the Twitter Terms of Service.

Parameters

cancellationToken

The cancellation token.

Returns

The sentense.

TosAsync() [2/4]

Task<StringResponse> CoreTweet.Rest.Help.TosAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the Twitter Terms of Service.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The sentense.

TosAsync() [3/4]

Task<StringResponse> CoreTweet.Rest.Help.TosAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Returns the Twitter Terms of Service.

Available parameters: Nothing.

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The sentense.

TosAsync() [4/4]

Task<StringResponse> CoreTweet.Rest.Help.TosAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Returns the Twitter Terms of Service.

Available parameters: Nothing.

Parameters

parameters

The parameters.

Returns

The sentense.

---

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

• CoreTweet/RestApis.cs