Class OauthApplicationClient

Namespace

Crews.PlanningCenter.Api.Api.V2019_02_13

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the OauthApplication resource.

public class OauthApplicationClient : SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>

Inheritance

object

ResourceClient<OauthApplication>

SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>

OauthApplicationClient

Inherited Members

SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>.PatchAsync(OauthApplication, CancellationToken)

SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>.PatchAsync(JsonApiDocument<OauthApplicationResource>, CancellationToken)

SingletonResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationResponse>.DeleteAsync(CancellationToken)

ResourceClient<OauthApplication>.AddQueryParameter(string, string)

ResourceClient<OauthApplication>.ReplaceQueryParameter(string, string)

ResourceClient<OauthApplication>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<OauthApplication>.Uri

ResourceClient<OauthApplication>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OauthApplicationClient(HttpClient, Uri)

Client for interacting with the OauthApplication resource.

public OauthApplicationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Mau

Associated Mau.

public PaginatedOauthApplicationMauClient Mau { get; }

Property Value

PaginatedOauthApplicationMauClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public OauthApplicationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

OauthApplicationClient

The current OauthApplicationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public OauthApplicationClient ClearParameters()

Returns

OauthApplicationClient

The current OauthApplicationClient instance.

GetAsync(CancellationToken)

Fetches the OauthApplication resource asynchronously.

public Task<OauthApplicationResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OauthApplicationResponse>

A task representing the asynchronous operation, containing the OauthApplication resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.