Class PaginatedSkippedAttachmentClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SkippedAttachment collection resources.

public class PaginatedSkippedAttachmentClient : PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>

Inheritance

object

ResourceClient<SkippedAttachment>

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>

PaginatedSkippedAttachmentClient

Inherited Members

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>.PerPage(int)

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>.Offset(int)

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>.Filter(string)

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>.PostAsync(SkippedAttachment, CancellationToken)

PaginatedResourceClient<SkippedAttachment, SkippedAttachmentResource, SkippedAttachmentCollectionResponse, SkippedAttachmentResponse>.PostAsync(JsonApiDocument<SkippedAttachmentResource>, CancellationToken)

ResourceClient<SkippedAttachment>.AddQueryParameter(string, string)

ResourceClient<SkippedAttachment>.ReplaceQueryParameter(string, string)

ResourceClient<SkippedAttachment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SkippedAttachment>.Uri

ResourceClient<SkippedAttachment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSkippedAttachmentClient(HttpClient, Uri)

Client for interacting with SkippedAttachment collection resources.

public PaginatedSkippedAttachmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSkippedAttachmentClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSkippedAttachmentClient

The current PaginatedSkippedAttachmentClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSkippedAttachmentClient ClearParameters()

Returns

PaginatedSkippedAttachmentClient

The current PaginatedSkippedAttachmentClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSkippedAttachmentClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSkippedAttachmentClient

The current PaginatedSkippedAttachmentClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SkippedAttachment resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SkippedAttachmentCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSkippedAttachmentClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSkippedAttachmentClient

The current PaginatedSkippedAttachmentClient instance.

PerPage(int)

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

public PaginatedSkippedAttachmentClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSkippedAttachmentClient

The current PaginatedSkippedAttachmentClient instance.

WithId(string)

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

public SkippedAttachmentClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SkippedAttachmentClient

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