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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAttachmentTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAttachmentTypeClient

The current PaginatedAttachmentTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAttachmentTypeClient ClearParameters()

Returns

PaginatedAttachmentTypeClient

The current PaginatedAttachmentTypeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAttachmentTypeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAttachmentTypeClient

The current PaginatedAttachmentTypeClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAttachmentTypeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAttachmentTypeClient

The current PaginatedAttachmentTypeClient instance.

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

PerPage(int)

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

public PaginatedAttachmentTypeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAttachmentTypeClient

The current PaginatedAttachmentTypeClient instance.

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.