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

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

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

Public Member Functions

MessageCreateEventResponse New (params Expression< Func< string, object >>[] parameters)
 
MessageCreateEventResponse New (IDictionary< string, object > parameters)
 
MessageCreateEventResponse New (object parameters)
 
MessageCreateEventResponse New (string text, long recipient_id, QuickReply quick_reply=null, string attachment_type=null, long? attachment_media_id=null, IEnumerable< MessageCallToAction > ctas=null)
 
Task< MessageCreateEventResponseNewAsync (params Expression< Func< string, object >>[] parameters)
 
Task< MessageCreateEventResponseNewAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< MessageCreateEventResponseNewAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< MessageCreateEventResponseNewAsync (string text, long recipient_id, QuickReply quick_reply=null, string attachment_type=null, long? attachment_media_id=null, IEnumerable< MessageCallToAction > ctas=null, CancellationToken cancellationToken=default(CancellationToken))
 
CursoredMessageCreateEvents List (params Expression< Func< string, object >>[] parameters)
 
CursoredMessageCreateEvents List (IDictionary< string, object > parameters)
 
CursoredMessageCreateEvents List (object parameters)
 
IEnumerable< MessageCreateEventEnumerateList (int? count=null, string cursor=null)
 
CursoredMessageCreateEvents List (int? count=null, string cursor=null)
 
IEnumerable< MessageCreateEventEnumerateList (params Expression< Func< string, object >>[] parameters)
 
IEnumerable< MessageCreateEventEnumerateList (IDictionary< string, object > parameters)
 
IEnumerable< MessageCreateEventEnumerateList (object parameters)
 
Task< CursoredMessageCreateEventsListAsync (params Expression< Func< string, object >>[] parameters)
 
Task< CursoredMessageCreateEventsListAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< CursoredMessageCreateEventsListAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< CursoredMessageCreateEventsListAsync (int? count=null, string cursor=null, CancellationToken cancellationToken=default(CancellationToken))
 
MessageCreateEventResponse Show (params Expression< Func< string, object >>[] parameters)
 
MessageCreateEventResponse Show (IDictionary< string, object > parameters)
 
MessageCreateEventResponse Show (object parameters)
 
MessageCreateEventResponse Show (string id)
 
Task< MessageCreateEventResponseShowAsync (params Expression< Func< string, object >>[] parameters)
 
Task< MessageCreateEventResponseShowAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< MessageCreateEventResponseShowAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< MessageCreateEventResponseShowAsync (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))
 

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 direct_messages/events.

Member Function Documentation

◆ Destroy() [1/4]

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

Deletes the direct message specified in the required ID parameter.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ Destroy() [2/4]

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

Deletes the direct message specified in the required ID parameter.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ Destroy() [3/4]

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

Deletes the direct message specified in the required ID parameter.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ Destroy() [4/4]

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

Deletes the direct message specified in the required ID parameter.

Parameters
idrequired.
Returns

◆ DestroyAsync() [1/4]

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

Deletes the direct message specified in the required ID parameter.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns

◆ DestroyAsync() [2/4]

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

Deletes the direct message specified in the required ID parameter.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns

◆ DestroyAsync() [3/4]

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

Deletes the direct message specified in the required ID parameter.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns

◆ DestroyAsync() [4/4]

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

Deletes the direct message specified in the required ID parameter.

Parameters
idrequired.
cancellationTokenThe cancellation token.
Returns

◆ EnumerateList() [1/4]

IEnumerable<MessageCreateEvent> CoreTweet.Rest.DirectMessagesEvents.EnumerateList ( IDictionary< string, object >  parameters)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ EnumerateList() [2/4]

IEnumerable<MessageCreateEvent> CoreTweet.Rest.DirectMessagesEvents.EnumerateList ( int?  count = null,
string  cursor = null 
)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Parameters
countoptional.
cursoroptional.
Returns
The Direct Messages.

◆ EnumerateList() [3/4]

IEnumerable<MessageCreateEvent> CoreTweet.Rest.DirectMessagesEvents.EnumerateList ( object  parameters)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ EnumerateList() [4/4]

IEnumerable<MessageCreateEvent> CoreTweet.Rest.DirectMessagesEvents.EnumerateList ( params Expression< Func< string, object >>[]  parameters)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ List() [1/4]

CursoredMessageCreateEvents CoreTweet.Rest.DirectMessagesEvents.List ( IDictionary< string, object >  parameters)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ List() [2/4]

CursoredMessageCreateEvents CoreTweet.Rest.DirectMessagesEvents.List ( int?  count = null,
string  cursor = null 
)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Parameters
countoptional.
cursoroptional.
Returns
The Direct Messages.

◆ List() [3/4]

CursoredMessageCreateEvents CoreTweet.Rest.DirectMessagesEvents.List ( object  parameters)
inline

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ List() [4/4]

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

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ ListAsync() [1/4]

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

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

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

◆ ListAsync() [2/4]

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

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

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

◆ ListAsync() [3/4]

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

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

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

◆ ListAsync() [4/4]

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

Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order.

Available parameters:

- int count (optional)

- string cursor (optional)

Parameters
parametersThe parameters.
Returns
The Direct Messages.

◆ New() [1/4]

MessageCreateEventResponse CoreTweet.Rest.DirectMessagesEvents.New ( IDictionary< string, object >  parameters)
inline

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Available parameters:

- string text (required)

- long recipient_id (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- IEnumerable<MessageCallToAction> ctas (optional)

Parameters
parametersThe parameters.
Returns
The published event.

◆ New() [2/4]

MessageCreateEventResponse CoreTweet.Rest.DirectMessagesEvents.New ( object  parameters)
inline

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Available parameters:

- string text (required)

- long recipient_id (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- IEnumerable<MessageCallToAction> ctas (optional)

Parameters
parametersThe parameters.
Returns
The published event.

◆ New() [3/4]

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

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Available parameters:

- string text (required)

- long recipient_id (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- IEnumerable<MessageCallToAction> ctas (optional)

Parameters
parametersThe parameters.
Returns
The published event.

◆ New() [4/4]

MessageCreateEventResponse CoreTweet.Rest.DirectMessagesEvents.New ( string  text,
long  recipient_id,
QuickReply  quick_reply = null,
string  attachment_type = null,
long?  attachment_media_id = null,
IEnumerable< MessageCallToAction ctas = null 
)
inline

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Parameters
textrequired.
recipient_idrequired.
quick_replyoptional.
attachment_typeoptional.
attachment_media_idoptional.
ctasoptional.
Returns
The published event.

◆ NewAsync() [1/4]

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

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Available parameters:

- string text (required)

- long recipient_id (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- IEnumerable<MessageCallToAction> ctas (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The published event.

◆ NewAsync() [2/4]

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

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Available parameters:

- string text (required)

- long recipient_id (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- IEnumerable<MessageCallToAction> ctas (optional)

Parameters
parametersThe parameters.
cancellationTokenThe cancellation token.
Returns
The published event.

◆ NewAsync() [3/4]

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

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Available parameters:

- string text (required)

- long recipient_id (required)

- QuickReply quick_reply (optional)

- string attachment_type (optional)

- long attachment_media_id (optional)

- IEnumerable<MessageCallToAction> ctas (optional)

Parameters
parametersThe parameters.
Returns
The published event.

◆ NewAsync() [4/4]

Task<MessageCreateEventResponse> CoreTweet.Rest.DirectMessagesEvents.NewAsync ( string  text,
long  recipient_id,
QuickReply  quick_reply = null,
string  attachment_type = null,
long?  attachment_media_id = null,
IEnumerable< MessageCallToAction ctas = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Publishes a new message_create event resulting in a Direct Message sent to a specified user from the authenticating user.

Parameters
textrequired.
recipient_idrequired.
quick_replyoptional.
attachment_typeoptional.
attachment_media_idoptional.
ctasoptional.
cancellationTokenThe cancellation token.
Returns
The published event.

◆ Show() [1/4]

MessageCreateEventResponse CoreTweet.Rest.DirectMessagesEvents.Show ( IDictionary< string, object >  parameters)
inline

Returns a single Direct Message event by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Direct Message.

◆ Show() [2/4]

MessageCreateEventResponse CoreTweet.Rest.DirectMessagesEvents.Show ( object  parameters)
inline

Returns a single Direct Message event by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Direct Message.

◆ Show() [3/4]

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

Returns a single Direct Message event by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Direct Message.

◆ Show() [4/4]

MessageCreateEventResponse CoreTweet.Rest.DirectMessagesEvents.Show ( string  id)
inline

Returns a single Direct Message event by the given id.

Parameters
idrequired.
Returns
The Direct Message.

◆ ShowAsync() [1/4]

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

Returns a single Direct Message event by the given id.

Available parameters:

- string id (required)

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

◆ ShowAsync() [2/4]

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

Returns a single Direct Message event by the given id.

Available parameters:

- string id (required)

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

◆ ShowAsync() [3/4]

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

Returns a single Direct Message event by the given id.

Available parameters:

- string id (required)

Parameters
parametersThe parameters.
Returns
The Direct Message.

◆ ShowAsync() [4/4]

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

Returns a single Direct Message event by the given id.

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

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