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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAttachmentTypeGroupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAttachmentTypeGroupClient

The current PaginatedAttachmentTypeGroupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAttachmentTypeGroupClient ClearParameters()

Returns

PaginatedAttachmentTypeGroupClient

The current PaginatedAttachmentTypeGroupClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAttachmentTypeGroupClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAttachmentTypeGroupClient

The current PaginatedAttachmentTypeGroupClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAttachmentTypeGroupClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAttachmentTypeGroupClient

The current PaginatedAttachmentTypeGroupClient instance.

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

PerPage(int)

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

public PaginatedAttachmentTypeGroupClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAttachmentTypeGroupClient

The current PaginatedAttachmentTypeGroupClient instance.

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.