Class PaginatedAttachmentTypeGroupClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AttachmentTypeGroup collection resources.

public class PaginatedAttachmentTypeGroupClient : PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>

Inheritance

object

ResourceClient<AttachmentTypeGroup>

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>

PaginatedAttachmentTypeGroupClient

Inherited Members

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>.PerPage(int)

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>.Offset(int)

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>.Filter(string)

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>.PostAsync(AttachmentTypeGroup, CancellationToken)

PaginatedResourceClient<AttachmentTypeGroup, AttachmentTypeGroupResource, AttachmentTypeGroupCollectionResponse, AttachmentTypeGroupResponse>.PostAsync(JsonApiDocument<AttachmentTypeGroupResource>, CancellationToken)

ResourceClient<AttachmentTypeGroup>.AddQueryParameter(string, string)

ResourceClient<AttachmentTypeGroup>.ReplaceQueryParameter(string, string)

ResourceClient<AttachmentTypeGroup>.AddCustomParameter(string, string)

ResourceClient<AttachmentTypeGroup>.ClearParameters()

ResourceClient<AttachmentTypeGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AttachmentTypeGroup>.Uri

ResourceClient<AttachmentTypeGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAttachmentTypeGroupClient(HttpClient, Uri)

Client for interacting with AttachmentTypeGroup collection resources.

public PaginatedAttachmentTypeGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of AttachmentTypeGroup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentTypeGroupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByName()

Sort response items by the Name attribute.

public AttachmentTypeGroupClient OrderByName()

Returns

AttachmentTypeGroupClient

OrderByNameDescending()

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

public AttachmentTypeGroupClient OrderByNameDescending()

Returns

AttachmentTypeGroupClient

WithId(string)

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

public AttachmentTypeGroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AttachmentTypeGroupClient

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