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

Provides a set of methods for the wrapper of User Lookup API on Twitter API v2. More...

Inheritance diagram for CoreTweet.V2.UserLookupApi:
CoreTweet.Core.ApiProviderBase

Public Member Functions

UserResponse GetUser (params Expression< Func< string, object >>[] parameters)
 
UserResponse GetUser (IDictionary< string, object > parameters)
 
UserResponse GetUser (object parameters)
 
UserResponse GetUser (long id, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null)
 
Task< UserResponseGetUserAsync (params Expression< Func< string, object >>[] parameters)
 
Task< UserResponseGetUserAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UserResponseGetUserAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UserResponseGetUserAsync (long id, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null, CancellationToken cancellationToken=default(CancellationToken))
 
UserResponse GetUserByUsername (params Expression< Func< string, object >>[] parameters)
 
UserResponse GetUserByUsername (IDictionary< string, object > parameters)
 
UserResponse GetUserByUsername (object parameters)
 
UserResponse GetUserByUsername (string username, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null)
 
Task< UserResponseGetUserByUsernameAsync (params Expression< Func< string, object >>[] parameters)
 
Task< UserResponseGetUserByUsernameAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UserResponseGetUserByUsernameAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UserResponseGetUserByUsernameAsync (string username, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null, CancellationToken cancellationToken=default(CancellationToken))
 
UsersResponse GetUsers (params Expression< Func< string, object >>[] parameters)
 
UsersResponse GetUsers (IDictionary< string, object > parameters)
 
UsersResponse GetUsers (object parameters)
 
UsersResponse GetUsers (IEnumerable< long > id, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null)
 
Task< UsersResponseGetUsersAsync (params Expression< Func< string, object >>[] parameters)
 
Task< UsersResponseGetUsersAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UsersResponseGetUsersAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UsersResponseGetUsersAsync (IEnumerable< long > id, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null, CancellationToken cancellationToken=default(CancellationToken))
 
UsersResponse GetUsersByUsernames (params Expression< Func< string, object >>[] parameters)
 
UsersResponse GetUsersByUsernames (IDictionary< string, object > parameters)
 
UsersResponse GetUsersByUsernames (object parameters)
 
UsersResponse GetUsersByUsernames (IEnumerable< string > usernames, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=null)
 
Task< UsersResponseGetUsersByUsernamesAsync (params Expression< Func< string, object >>[] parameters)
 
Task< UsersResponseGetUsersByUsernamesAsync (IDictionary< string, object > parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UsersResponseGetUsersByUsernamesAsync (object parameters, CancellationToken cancellationToken=default(CancellationToken))
 
Task< UsersResponseGetUsersByUsernamesAsync (IEnumerable< string > usernames, UserExpansions? expansions=null, TweetFields? tweet_fields=null, UserFields? user_fields=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 User Lookup API on Twitter API v2.

Member Function Documentation

◆ GetUser() [1/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUser ( IDictionary< string, object >  parameters)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Available parameters:

- long id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUser() [2/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUser ( long  id,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null 
)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Parameters
idrequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
Returns
The User.

◆ GetUser() [3/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUser ( object  parameters)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Available parameters:

- long id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUser() [4/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUser ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Available parameters:

- long id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUserAsync() [1/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Available parameters:

- long id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUserAsync() [2/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserAsync ( long  id,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Parameters
idrequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
cancellationTokenThe cancellation token.
Returns
The User.

◆ GetUserAsync() [3/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Available parameters:

- long id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUserAsync() [4/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about a single more user specified by the requested ID. By default, only the ID, the username and the user's profile name are returned.

Available parameters:

- long id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUserByUsername() [1/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUserByUsername ( IDictionary< string, object >  parameters)
inline

Returns a variety of information about one User specified by the requested username.

Available parameters:

- string username (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUserByUsername() [2/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUserByUsername ( object  parameters)
inline

Returns a variety of information about one User specified by the requested username.

Available parameters:

- string username (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUserByUsername() [3/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUserByUsername ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about one User specified by the requested username.

Available parameters:

- string username (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUserByUsername() [4/4]

UserResponse CoreTweet.V2.UserLookupApi.GetUserByUsername ( string  username,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null 
)
inline

Returns a variety of information about one User specified by the requested username.

Parameters
usernamerequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
Returns
The User.

◆ GetUserByUsernameAsync() [1/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserByUsernameAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one User specified by the requested username.

Available parameters:

- string username (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUserByUsernameAsync() [2/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserByUsernameAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one User specified by the requested username.

Available parameters:

- string username (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUserByUsernameAsync() [3/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserByUsernameAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about one User specified by the requested username.

Available parameters:

- string username (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The User.

◆ GetUserByUsernameAsync() [4/4]

Task<UserResponse> CoreTweet.V2.UserLookupApi.GetUserByUsernameAsync ( string  username,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one User specified by the requested username.

Parameters
usernamerequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
cancellationTokenThe cancellation token.
Returns
The User.

◆ GetUsers() [1/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsers ( IDictionary< string, object >  parameters)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Available parameters:

- IEnumerable<long> id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsers() [2/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsers ( IEnumerable< long >  id,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null 
)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Parameters
idrequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
Returns
The Users.

◆ GetUsers() [3/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsers ( object  parameters)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Available parameters:

- IEnumerable<long> id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsers() [4/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsers ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Available parameters:

- IEnumerable<long> id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsersAsync() [1/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Available parameters:

- IEnumerable<long> id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUsersAsync() [2/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersAsync ( IEnumerable< long >  id,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Parameters
idrequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
cancellationTokenThe cancellation token.
Returns
The Users.

◆ GetUsersAsync() [3/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Available parameters:

- IEnumerable<long> id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUsersAsync() [4/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about one or more Users specified by the requested IDs.

Available parameters:

- IEnumerable<long> id (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsersByUsernames() [1/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsersByUsernames ( IDictionary< string, object >  parameters)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Available parameters:

- IEnumerable<string> usernames (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsersByUsernames() [2/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsersByUsernames ( IEnumerable< string >  usernames,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null 
)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Parameters
usernamesrequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
Returns
The Users.

◆ GetUsersByUsernames() [3/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsersByUsernames ( object  parameters)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Available parameters:

- IEnumerable<string> usernames (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsersByUsernames() [4/4]

UsersResponse CoreTweet.V2.UserLookupApi.GetUsersByUsernames ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Available parameters:

- IEnumerable<string> usernames (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

◆ GetUsersByUsernamesAsync() [1/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersByUsernamesAsync ( IDictionary< string, object >  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Available parameters:

- IEnumerable<string> usernames (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUsersByUsernamesAsync() [2/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersByUsernamesAsync ( IEnumerable< string >  usernames,
UserExpansions expansions = null,
TweetFields tweet_fields = null,
UserFields user_fields = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Parameters
usernamesrequired.
expansionsoptional.
tweet_fieldsoptional.
user_fieldsoptional.
cancellationTokenThe cancellation token.
Returns
The Users.

◆ GetUsersByUsernamesAsync() [3/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersByUsernamesAsync ( object  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Available parameters:

- IEnumerable<string> usernames (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

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

◆ GetUsersByUsernamesAsync() [4/4]

Task<UsersResponse> CoreTweet.V2.UserLookupApi.GetUsersByUsernamesAsync ( params Expression< Func< string, object >>[]  parameters)
inline

Returns a variety of information about one or more Users specified by the requested usernames.

Available parameters:

- IEnumerable<string> usernames (required)

- UserExpansions expansions (optional)

- TweetFields tweet_fields (optional, query string: "tweet.fields")

- UserFields user_fields (optional, query string: "user.fields")

Parameters
parametersThe parameters.
Returns
The Users.

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