Class FluxerOAuthClient

Namespace

Fluxer.Net.OAuth

Assembly

Fluxer.Net.dll

OAuth client used for Fluxer.

public class FluxerOAuthClient : FluxerBaseClient

Inheritance

object

FluxerBaseClient

FluxerOAuthClient

Inherited Members

FluxerBaseClient.Config

Constructors

FluxerOAuthClient(ulong, string, FluxerConfig?)

Create an OAuth client with id and secret then use access or refresh tokens.

public FluxerOAuthClient(ulong clientId, string clientSecret, FluxerConfig? config = null)

Parameters

clientId ulong

clientSecret string

config FluxerConfig

Exceptions

ArgumentNullException

ArgumentException

Properties

ClientId

Client id for the OAuth app.

public ulong ClientId { get; }

Property Value

ulong

ClientSecret

Client secret for the OAuth app.

public string ClientSecret { get; }

Property Value

string

Rest

Http client for Fluxer with requests.

public FluxerApiClient Rest { get; }

Property Value

FluxerApiClient

Methods

CheckValidTokenAsync(string, RequestOptions?)

Check if oauth token is valid.

public Task<bool> CheckValidTokenAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task<bool>

FluxerOAuthValidToken

ExchangeRefreshTokenAsync(string, RequestOptions?)

Get new access token from refresh token.

public Task<FluxerOAuthRefreshToken> ExchangeRefreshTokenAsync(string refreshToken, RequestOptions? options = null)

Parameters

refreshToken string

options RequestOptions

Returns

Task<FluxerOAuthRefreshToken>

FluxerOAuthRefreshToken

GetConnectionsAsync(string, RequestOptions?)

Get user connections from access token.

public Task<IEnumerable<UserConnection>> GetConnectionsAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task<IEnumerable<UserConnection>>

List of UserConnection

GetGuildsAsync(string, RequestOptions?)

Get user guilds from access token.

public Task<IEnumerable<Guild>> GetGuildsAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task<IEnumerable<Guild>>

List of Guild

GetTokenAsync(string, RequestOptions?)

Get oauth token from access token.

public Task<FluxerOAuthToken?> GetTokenAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task<FluxerOAuthToken>

FluxerOAuthToken

GetUserAsync(string, RequestOptions?)

Get user from access token.

public Task<FluxerOAuthUser?> GetUserAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task<FluxerOAuthUser>

FluxerOAuthUser

GetValidTokenAsync(string, RequestOptions?)

Check if oauth token is valid.

public Task<FluxerOAuthValidToken?> GetValidTokenAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task<FluxerOAuthValidToken>

FluxerOAuthValidToken

RevokeAccessTokenAsync(string, RequestOptions?)

Remove access for access token.

public Task RevokeAccessTokenAsync(string accessToken, RequestOptions? options = null)

Parameters

accessToken string

options RequestOptions

Returns

Task

RevokeRefreshTokenAsync(string, RequestOptions?)

Remove access for refresh token.

public Task RevokeRefreshTokenAsync(string refreshToken, RequestOptions? options = null)

Parameters

refreshToken string

options RequestOptions

Returns

Task