Class PaginatedResourceQuestionClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ResourceQuestion collection resources.

public class PaginatedResourceQuestionClient : PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>

Inheritance

object

ResourceClient<ResourceQuestion>

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>

PaginatedResourceQuestionClient

Inherited Members

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>.PerPage(int)

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>.Offset(int)

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>.Filter(string)

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>.PostAsync(ResourceQuestion, CancellationToken)

PaginatedResourceClient<ResourceQuestion, ResourceQuestionResource, ResourceQuestionCollectionResponse, ResourceQuestionResponse>.PostAsync(JsonApiDocument<ResourceQuestionResource>, CancellationToken)

ResourceClient<ResourceQuestion>.AddQueryParameter(string, string)

ResourceClient<ResourceQuestion>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceQuestion>.AddCustomParameter(string, string)

ResourceClient<ResourceQuestion>.ClearParameters()

ResourceClient<ResourceQuestion>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceQuestion>.Uri

ResourceClient<ResourceQuestion>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedResourceQuestionClient(HttpClient, Uri)

Client for interacting with ResourceQuestion collection resources.

public PaginatedResourceQuestionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ResourceQuestion resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceQuestionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(ResourceQuestion, CancellationToken)

Creates a new ResourceQuestion resource asynchronously.

public Task<ResourceQuestionResponse> PostAsync(ResourceQuestion resource, CancellationToken cancellationToken = default)

Parameters

resource ResourceQuestion

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceQuestionResponse>

A task representing the asynchronous operation, containing the created ResourceQuestion resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ResourceQuestionResource>, CancellationToken)

Creates a new ResourceQuestion resource asynchronously.

public Task<ResourceQuestionResponse> PostAsync(JsonApiDocument<ResourceQuestionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ResourceQuestionResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceQuestionResponse>

A task representing the asynchronous operation, containing the created ResourceQuestion resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public ResourceQuestionClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceQuestionClient

WhereKind(string)

Query response items by the Kind attribute.

public ResourceQuestionClient WhereKind(string value)

Parameters

value string

Returns

ResourceQuestionClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public ResourceQuestionClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

ResourceQuestionClient

WithId(string)

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

public ResourceQuestionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ResourceQuestionClient

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