Class PaginatedOauthApplicationMauClient

Namespace

Crews.PlanningCenter.Api.Api.V2019_02_13

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with OauthApplicationMau collection resources.

public class PaginatedOauthApplicationMauClient : PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>

Inheritance

object

ResourceClient<OauthApplicationMau>

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>

PaginatedOauthApplicationMauClient

Inherited Members

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>.PerPage(int)

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>.Offset(int)

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>.Filter(string)

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>.PostAsync(OauthApplicationMau, CancellationToken)

PaginatedResourceClient<OauthApplicationMau, OauthApplicationMauResource, OauthApplicationMauCollectionResponse, OauthApplicationMauResponse>.PostAsync(JsonApiDocument<OauthApplicationMauResource>, CancellationToken)

ResourceClient<OauthApplicationMau>.AddQueryParameter(string, string)

ResourceClient<OauthApplicationMau>.ReplaceQueryParameter(string, string)

ResourceClient<OauthApplicationMau>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<OauthApplicationMau>.Uri

ResourceClient<OauthApplicationMau>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedOauthApplicationMauClient(HttpClient, Uri)

Client for interacting with OauthApplicationMau collection resources.

public PaginatedOauthApplicationMauClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedOauthApplicationMauClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedOauthApplicationMauClient

The current PaginatedOauthApplicationMauClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedOauthApplicationMauClient ClearParameters()

Returns

PaginatedOauthApplicationMauClient

The current PaginatedOauthApplicationMauClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedOauthApplicationMauClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedOauthApplicationMauClient

The current PaginatedOauthApplicationMauClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of OauthApplicationMau resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OauthApplicationMauCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of OauthApplicationMau resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedOauthApplicationMauClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedOauthApplicationMauClient

The current PaginatedOauthApplicationMauClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedOauthApplicationMauClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedOauthApplicationMauClient

The current PaginatedOauthApplicationMauClient instance.

WithId(string)

Creates a new instance of a OauthApplicationMau client for a specific resource ID.

public OauthApplicationMauClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

OauthApplicationMauClient

A new instance of the resource client for the specified resource ID.