Class PaginatedWorkflowCardNoteClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with WorkflowCardNote collection resources.

public class PaginatedWorkflowCardNoteClient : PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>

Inheritance

object

ResourceClient<WorkflowCardNote>

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>

PaginatedWorkflowCardNoteClient

Inherited Members

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>.PerPage(int)

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>.Offset(int)

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>.Filter(string)

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>.PostAsync(WorkflowCardNote, CancellationToken)

PaginatedResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteCollectionResponse, WorkflowCardNoteResponse>.PostAsync(JsonApiDocument<WorkflowCardNoteResource>, CancellationToken)

ResourceClient<WorkflowCardNote>.AddQueryParameter(string, string)

ResourceClient<WorkflowCardNote>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCardNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCardNote>.Uri

ResourceClient<WorkflowCardNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedWorkflowCardNoteClient(HttpClient, Uri)

Client for interacting with WorkflowCardNote collection resources.

public PaginatedWorkflowCardNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedWorkflowCardNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedWorkflowCardNoteClient

The current PaginatedWorkflowCardNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedWorkflowCardNoteClient ClearParameters()

Returns

PaginatedWorkflowCardNoteClient

The current PaginatedWorkflowCardNoteClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedWorkflowCardNoteClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedWorkflowCardNoteClient

The current PaginatedWorkflowCardNoteClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of WorkflowCardNote resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardNoteCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedWorkflowCardNoteClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedWorkflowCardNoteClient

The current PaginatedWorkflowCardNoteClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public WorkflowCardNoteClient OrderByCreatedAt()

Returns

WorkflowCardNoteClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public WorkflowCardNoteClient OrderByCreatedAtDescending()

Returns

WorkflowCardNoteClient

PerPage(int)

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

public PaginatedWorkflowCardNoteClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedWorkflowCardNoteClient

The current PaginatedWorkflowCardNoteClient instance.

PostAsync(WorkflowCardNote, CancellationToken)

Creates a new WorkflowCardNote resource asynchronously.

public Task<WorkflowCardNoteResponse> PostAsync(WorkflowCardNote resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowCardNote

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<WorkflowCardNoteResource>, CancellationToken)

Creates a new WorkflowCardNote resource asynchronously.

public Task<WorkflowCardNoteResponse> PostAsync(JsonApiDocument<WorkflowCardNoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowCardNoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public WorkflowCardNoteClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

WorkflowCardNoteClient

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