Class PaginatedAttachmentTypeClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AttachmentType collection resources.

public class PaginatedAttachmentTypeClient : PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>

Inheritance

object

ResourceClient<AttachmentType>

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>

PaginatedAttachmentTypeClient

Inherited Members

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>.PerPage(int)

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>.Offset(int)

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>.Filter(string)

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>.PostAsync(AttachmentType, CancellationToken)

PaginatedResourceClient<AttachmentType, AttachmentTypeResource, AttachmentTypeCollectionResponse, AttachmentTypeResponse>.PostAsync(JsonApiDocument<AttachmentTypeResource>, CancellationToken)

ResourceClient<AttachmentType>.AddQueryParameter(string, string)

ResourceClient<AttachmentType>.ReplaceQueryParameter(string, string)

ResourceClient<AttachmentType>.AddCustomParameter(string, string)

ResourceClient<AttachmentType>.ClearParameters()

ResourceClient<AttachmentType>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AttachmentType>.Uri

ResourceClient<AttachmentType>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAttachmentTypeClient(HttpClient, Uri)

Client for interacting with AttachmentType collection resources.

public PaginatedAttachmentTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of AttachmentType resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentTypeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByName()

Sort response items by the Name attribute.

public AttachmentTypeClient OrderByName()

Returns

AttachmentTypeClient

OrderByNameDescending()

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

public AttachmentTypeClient OrderByNameDescending()

Returns

AttachmentTypeClient

WithId(string)

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

public AttachmentTypeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AttachmentTypeClient

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