CoreTweet.V2.FilteredStreamApi Class Reference

Provides a set of methods for the wrapper of Filtered stream v1 API on Twitter API v2. More...

Inheritance diagram for CoreTweet.V2.FilteredStreamApi:

Public Member Functions
FilterRulesGetResponse	GetRules (params Expression< Func< string, object >>[] parameters)
FilterRulesGetResponse	GetRules (IDictionary< string, object > parameters)
FilterRulesGetResponse	GetRules (object parameters)
FilterRulesGetResponse	GetRules (IEnumerable< long > ids=null)
Task< FilterRulesGetResponse >	GetRulesAsync (params Expression< Func< string, object >>[] parameters)
Task< FilterRulesGetResponse >	GetRulesAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< FilterRulesGetResponse >	GetRulesAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< FilterRulesGetResponse >	GetRulesAsync (IEnumerable< long > ids=null, CancellationToken cancellationToken=default(CancellationToken))
FilterRulesPostCreateResponse	CreateRules (params Expression< Func< string, object >>[] parameters)
FilterRulesPostCreateResponse	CreateRules (IDictionary< string, object > parameters)
FilterRulesPostCreateResponse	CreateRules (object parameters)
FilterRulesPostCreateResponse	CreateRules (IEnumerable< FilterRule > add, bool? dry_run=null)
Task< FilterRulesPostCreateResponse >	CreateRulesAsync (params Expression< Func< string, object >>[] parameters)
Task< FilterRulesPostCreateResponse >	CreateRulesAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< FilterRulesPostCreateResponse >	CreateRulesAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< FilterRulesPostCreateResponse >	CreateRulesAsync (IEnumerable< FilterRule > add, bool? dry_run=null, CancellationToken cancellationToken=default(CancellationToken))
FilterRulesPostDeleteResponse	DeleteRules (params Expression< Func< string, object >>[] parameters)
FilterRulesPostDeleteResponse	DeleteRules (IDictionary< string, object > parameters)
FilterRulesPostDeleteResponse	DeleteRules (object parameters)
FilterRulesPostDeleteResponse	DeleteRules (IEnumerable< long > ids=null, IEnumerable< string > values=null, bool? dry_run=null)
Task< FilterRulesPostDeleteResponse >	DeleteRulesAsync (params Expression< Func< string, object >>[] parameters)
Task< FilterRulesPostDeleteResponse >	DeleteRulesAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< FilterRulesPostDeleteResponse >	DeleteRulesAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
Task< FilterRulesPostDeleteResponse >	DeleteRulesAsync (IEnumerable< long > ids=null, IEnumerable< string > values=null, bool? dry_run=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 Filtered stream v1 API on Twitter API v2.

Member Function Documentation

CreateRules() [1/4]

FilterRulesPostCreateResponse CoreTweet.V2.FilteredStreamApi.CreateRules ( IDictionary< string, object >  parameters )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Available parameters:

- IEnumerable<FilterRule> add (required)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

CreateRules() [2/4]

FilterRulesPostCreateResponse CoreTweet.V2.FilteredStreamApi.CreateRules ( IEnumerable< FilterRule >  add, bool?  dry_run = null  )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Parameters

add	required.
dry_run	optional.

Returns

The result of the request.

CreateRules() [3/4]

FilterRulesPostCreateResponse CoreTweet.V2.FilteredStreamApi.CreateRules ( object  parameters )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Available parameters:

- IEnumerable<FilterRule> add (required)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

CreateRules() [4/4]

FilterRulesPostCreateResponse CoreTweet.V2.FilteredStreamApi.CreateRules ( params Expression< Func< string, object >>[]  parameters )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Available parameters:

- IEnumerable<FilterRule> add (required)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

CreateRulesAsync() [1/4]

Task<FilterRulesPostCreateResponse> CoreTweet.V2.FilteredStreamApi.CreateRulesAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Available parameters:

- IEnumerable<FilterRule> add (required)

- bool dry_run (optional)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The result of the request.

CreateRulesAsync() [2/4]

Task<FilterRulesPostCreateResponse> CoreTweet.V2.FilteredStreamApi.CreateRulesAsync ( IEnumerable< FilterRule >  add, bool?  dry_run = null, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Parameters

add	required.
dry_run	optional.
cancellationToken	The cancellation token.

Returns

The result of the request.

CreateRulesAsync() [3/4]

Task<FilterRulesPostCreateResponse> CoreTweet.V2.FilteredStreamApi.CreateRulesAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Available parameters:

- IEnumerable<FilterRule> add (required)

- bool dry_run (optional)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The result of the request.

CreateRulesAsync() [4/4]

Task<FilterRulesPostCreateResponse> CoreTweet.V2.FilteredStreamApi.CreateRulesAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Creates filter rules. To create one or more rules, submit an add payload as an array of rules and operators.

Available parameters:

- IEnumerable<FilterRule> add (required)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

DeleteRules() [1/4]

FilterRulesPostDeleteResponse CoreTweet.V2.FilteredStreamApi.DeleteRules ( IDictionary< string, object >  parameters )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Available parameters:

- IEnumerable<long> ids (optional)

- IEnumerable<string> values (optional)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

DeleteRules() [2/4]

FilterRulesPostDeleteResponse CoreTweet.V2.FilteredStreamApi.DeleteRules ( IEnumerable< long >  ids = null, IEnumerable< string >  values = null, bool?  dry_run = null  )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Parameters

ids	optional.
values	optional.
dry_run	optional.

Returns

The result of the request.

DeleteRules() [3/4]

FilterRulesPostDeleteResponse CoreTweet.V2.FilteredStreamApi.DeleteRules ( object  parameters )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Available parameters:

- IEnumerable<long> ids (optional)

- IEnumerable<string> values (optional)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

DeleteRules() [4/4]

FilterRulesPostDeleteResponse CoreTweet.V2.FilteredStreamApi.DeleteRules ( params Expression< Func< string, object >>[]  parameters )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Available parameters:

- IEnumerable<long> ids (optional)

- IEnumerable<string> values (optional)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

DeleteRulesAsync() [1/4]

Task<FilterRulesPostDeleteResponse> CoreTweet.V2.FilteredStreamApi.DeleteRulesAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Available parameters:

- IEnumerable<long> ids (optional)

- IEnumerable<string> values (optional)

- bool dry_run (optional)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The result of the request.

DeleteRulesAsync() [2/4]

Task<FilterRulesPostDeleteResponse> CoreTweet.V2.FilteredStreamApi.DeleteRulesAsync ( IEnumerable< long >  ids = null, IEnumerable< string >  values = null, bool?  dry_run = null, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Parameters

ids	optional.
values	optional.
dry_run	optional.
cancellationToken	The cancellation token.

Returns

The result of the request.

DeleteRulesAsync() [3/4]

Task<FilterRulesPostDeleteResponse> CoreTweet.V2.FilteredStreamApi.DeleteRulesAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Available parameters:

- IEnumerable<long> ids (optional)

- IEnumerable<string> values (optional)

- bool dry_run (optional)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The result of the request.

DeleteRulesAsync() [4/4]

Task<FilterRulesPostDeleteResponse> CoreTweet.V2.FilteredStreamApi.DeleteRulesAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Deletes filter rules. This endpoint can delete multiple rules at a time by specifying an array of IDs. If one or more rules cannot be deleted (for example, because it does not exist), the operation will not fail. In other words, only existing rules will be deleted.

Available parameters:

- IEnumerable<long> ids (optional)

- IEnumerable<string> values (optional)

- bool dry_run (optional)

Parameters

parameters

The parameters.

Returns

The result of the request.

GetRules() [1/4]

FilterRulesGetResponse CoreTweet.V2.FilteredStreamApi.GetRules ( IDictionary< string, object >  parameters )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Available parameters:

- IEnumerable<long> ids (optional)

Parameters

parameters

The parameters.

Returns

The rules.

GetRules() [2/4]

FilterRulesGetResponse CoreTweet.V2.FilteredStreamApi.GetRules ( IEnumerable< long >  ids = null )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Parameters

ids

optional.

Returns

The rules.

GetRules() [3/4]

FilterRulesGetResponse CoreTweet.V2.FilteredStreamApi.GetRules ( object  parameters )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Available parameters:

- IEnumerable<long> ids (optional)

Parameters

parameters

The parameters.

Returns

The rules.

GetRules() [4/4]

FilterRulesGetResponse CoreTweet.V2.FilteredStreamApi.GetRules ( params Expression< Func< string, object >>[]  parameters )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Available parameters:

- IEnumerable<long> ids (optional)

Parameters

parameters

The parameters.

Returns

The rules.

GetRulesAsync() [1/4]

Task<FilterRulesGetResponse> CoreTweet.V2.FilteredStreamApi.GetRulesAsync ( IDictionary< string, object >  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Available parameters:

- IEnumerable<long> ids (optional)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The rules.

GetRulesAsync() [2/4]

Task<FilterRulesGetResponse> CoreTweet.V2.FilteredStreamApi.GetRulesAsync ( IEnumerable< long >  ids = null, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Parameters

ids	optional.
cancellationToken	The cancellation token.

Returns

The rules.

GetRulesAsync() [3/4]

Task<FilterRulesGetResponse> CoreTweet.V2.FilteredStreamApi.GetRulesAsync ( object  parameters, CancellationToken  cancellationToken = default(CancellationToken)  )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Available parameters:

- IEnumerable<long> ids (optional)

Parameters

parameters	The parameters.
cancellationToken	The cancellation token.

Returns

The rules.

GetRulesAsync() [4/4]

Task<FilterRulesGetResponse> CoreTweet.V2.FilteredStreamApi.GetRulesAsync ( params Expression< Func< string, object >>[]  parameters )

inline

Return a list of filter rules currently active on the streaming endpoint, either as a list or individually.

Available parameters:

- IEnumerable<long> ids (optional)

Parameters

parameters

The parameters.

Returns

The rules.

---

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

• CoreTweet/RestApis.cs
• CoreTweet/V2/Stream.cs