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

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

Public Member Functions

WelcomeMessageResponse New (params Expression< Func< string, object >>[] parameters)
 
WelcomeMessageResponse New (IDictionary< string, object > parameters)
 
WelcomeMessageResponse New (object parameters)
 
WelcomeMessageResponse New (string text, QuickReply quick_reply=null, string attachment_type=null, long? attachment_media_id=null, string name=null)
 
Task< WelcomeMessageResponseNewAsync (params Expression< Func< string, object >>[] parameters)
 
Task< WelcomeMessageResponseNewAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< WelcomeMessageResponseNewAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< WelcomeMessageResponseNewAsync (string text, QuickReply quick_reply=null, string attachment_type=null, long? attachment_media_id=null, string name=null, CancellationToken cancellationToken=default(CancellationToken))
 
CursoredWelcomeMessages List (params Expression< Func< string, object >>[] parameters)
 
CursoredWelcomeMessages List (IDictionary< string, object > parameters)
 
CursoredWelcomeMessages List (object parameters)
 
CursoredWelcomeMessages List (int? count=null, string cursor=null)
 
Task< CursoredWelcomeMessagesListAsync (params Expression< Func< string, object >>[] parameters)
 
Task< CursoredWelcomeMessagesListAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< CursoredWelcomeMessagesListAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< CursoredWelcomeMessagesListAsync (int? count=null, string cursor=null, CancellationToken cancellationToken=default(CancellationToken))
 
WelcomeMessageResponse Show (params Expression< Func< string, object >>[] parameters)
 
WelcomeMessageResponse Show (IDictionary< string, object > parameters)
 
WelcomeMessageResponse Show (object parameters)
 
WelcomeMessageResponse Show (string id)
 
Task< WelcomeMessageResponseShowAsync (params Expression< Func< string, object >>[] parameters)
 
Task< WelcomeMessageResponseShowAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< WelcomeMessageResponseShowAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< WelcomeMessageResponseShowAsync (string id, CancellationToken cancellationToken=default(CancellationToken))
 
void Destroy (params Expression< Func< string, object >>[] parameters)
 
void Destroy (IDictionary< string, object > parameters)
 
void Destroy (object parameters)
 
void Destroy (string id)
 
Task DestroyAsync (params Expression< Func< string, object >>[] parameters)
 
Task DestroyAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task DestroyAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task DestroyAsync (string id, CancellationToken cancellationToken=default(CancellationToken))
 

Public Attributes

WelcomeMessagesRules Rules => new WelcomeMessagesRules(this.Tokens)
 Gets the wrapper of direct_messages/welcome_messages/rules. More...
 

Detailed Description

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

Member Function Documentation

◆ Destroy() [1/4]

void CoreTweet.Rest.WelcomeMessages.Destroy ( IDictionary< string, object >  parameters)
inline

Deletes a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ Destroy() [2/4]

void CoreTweet.Rest.WelcomeMessages.Destroy ( object  parameters)
inline

Deletes a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ Destroy() [3/4]

void CoreTweet.Rest.WelcomeMessages.Destroy ( params Expression< Func< string, object >>[]  parameters)
inline

Deletes a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ Destroy() [4/4]

void CoreTweet.Rest.WelcomeMessages.Destroy ( string  id)
inline

Deletes a Welcome Message by the given id.

Parameters
idrequired.
Returns

◆ DestroyAsync() [1/4]

Task CoreTweet.Rest.WelcomeMessages.DestroyAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Deletes a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns

◆ DestroyAsync() [2/4]

Task CoreTweet.Rest.WelcomeMessages.DestroyAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Deletes a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns

◆ DestroyAsync() [3/4]

Task CoreTweet.Rest.WelcomeMessages.DestroyAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Deletes a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ DestroyAsync() [4/4]

Task CoreTweet.Rest.WelcomeMessages.DestroyAsync ( string  id,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Deletes a Welcome Message by the given id.

Parameters
idrequired.
cancellationTokenThe cancellation token.
Returns

◆ List() [1/4]

CursoredWelcomeMessages CoreTweet.Rest.WelcomeMessages.List ( IDictionary< string, object >  parameters)
inline

Returns a list of Welcome Messages.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Welcome Messages.

◆ List() [2/4]

CursoredWelcomeMessages CoreTweet.Rest.WelcomeMessages.List ( int?  count = null,
string  cursor = null 
)
inline

Returns a list of Welcome Messages.

Parameters
countoptional.
cursoroptional.
Returns
The Welcome Messages.

◆ List() [3/4]

CursoredWelcomeMessages CoreTweet.Rest.WelcomeMessages.List ( object  parameters)
inline

Returns a list of Welcome Messages.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Welcome Messages.

◆ List() [4/4]

CursoredWelcomeMessages CoreTweet.Rest.WelcomeMessages.List ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a list of Welcome Messages.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Welcome Messages.

◆ ListAsync() [1/4]

Task<CursoredWelcomeMessages> CoreTweet.Rest.WelcomeMessages.ListAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a list of Welcome Messages.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The Welcome Messages.

◆ ListAsync() [2/4]

Task<CursoredWelcomeMessages> CoreTweet.Rest.WelcomeMessages.ListAsync ( int?  count = null,
string  cursor = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a list of Welcome Messages.

Parameters
countoptional.
cursoroptional.
cancellationTokenThe cancellation token.
Returns
The Welcome Messages.

◆ ListAsync() [3/4]

Task<CursoredWelcomeMessages> CoreTweet.Rest.WelcomeMessages.ListAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a list of Welcome Messages.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The Welcome Messages.

◆ ListAsync() [4/4]

Task<CursoredWelcomeMessages> CoreTweet.Rest.WelcomeMessages.ListAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a list of Welcome Messages.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Welcome Messages.

◆ New() [1/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.New ( IDictionary< string, object >  parameters)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Available parameters:

- string text (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- string name (optional)

Parameters
parametersThe parameters.
Returns
The message template.

◆ New() [2/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.New ( object  parameters)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Available parameters:

- string text (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- string name (optional)

Parameters
parametersThe parameters.
Returns
The message template.

◆ New() [3/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.New ( params Expression< Func< string, object >>[]  parameters)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Available parameters:

- string text (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- string name (optional)

Parameters
parametersThe parameters.
Returns
The message template.

◆ New() [4/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.New ( string  text,
QuickReply  quick_reply = null,
string  attachment_type = null,
long?  attachment_media_id = null,
string  name = null 
)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Parameters
textrequired.
quick_replyoptional.
attachment_typeoptional.
attachment_media_idoptional.
nameoptional.
Returns
The message template.

◆ NewAsync() [1/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.NewAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Available parameters:

- string text (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- string name (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The message template.

◆ NewAsync() [2/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.NewAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Available parameters:

- string text (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- string name (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The message template.

◆ NewAsync() [3/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.NewAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Available parameters:

- string text (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- string name (optional)

Parameters
parametersThe parameters.
Returns
The message template.

◆ NewAsync() [4/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.NewAsync ( string  text,
QuickReply  quick_reply = null,
string  attachment_type = null,
long?  attachment_media_id = null,
string  name = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances.

Parameters
textrequired.
quick_replyoptional.
attachment_typeoptional.
attachment_media_idoptional.
nameoptional.
cancellationTokenThe cancellation token.
Returns
The message template.

◆ Show() [1/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.Show ( IDictionary< string, object >  parameters)
inline

Returns a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Welcome Message.

◆ Show() [2/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.Show ( object  parameters)
inline

Returns a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Welcome Message.

◆ Show() [3/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.Show ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Welcome Message.

◆ Show() [4/4]

WelcomeMessageResponse CoreTweet.Rest.WelcomeMessages.Show ( string  id)
inline

Returns a Welcome Message by the given id.

Parameters
idrequired.
Returns
The Welcome Message.

◆ ShowAsync() [1/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.ShowAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The Welcome Message.

◆ ShowAsync() [2/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.ShowAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The Welcome Message.

◆ ShowAsync() [3/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.ShowAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a Welcome Message by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Welcome Message.

◆ ShowAsync() [4/4]

Task<WelcomeMessageResponse> CoreTweet.Rest.WelcomeMessages.ShowAsync ( string  id,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a Welcome Message by the given id.

Parameters
idrequired.
cancellationTokenThe cancellation token.
Returns
The Welcome Message.

Member Data Documentation

◆ Rules

WelcomeMessagesRules CoreTweet.Rest.WelcomeMessages.Rules => new WelcomeMessagesRules(this.Tokens)

Gets the wrapper of direct_messages/welcome_messages/rules.


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