Class PaginatedAttachmentClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Attachment collection resources.

public class PaginatedAttachmentClient : PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>

Inheritance

object

ResourceClient<Attachment>

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>

PaginatedAttachmentClient

Inherited Members

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>.PerPage(int)

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>.Offset(int)

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>.Filter(string)

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>.PostAsync(Attachment, CancellationToken)

PaginatedResourceClient<Attachment, AttachmentResource, AttachmentCollectionResponse, AttachmentResponse>.PostAsync(JsonApiDocument<AttachmentResource>, CancellationToken)

ResourceClient<Attachment>.AddQueryParameter(string, string)

ResourceClient<Attachment>.ReplaceQueryParameter(string, string)

ResourceClient<Attachment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Attachment>.Uri

ResourceClient<Attachment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAttachmentClient(HttpClient, Uri)

Client for interacting with Attachment collection resources.

public PaginatedAttachmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAttachmentClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAttachmentClient

The current PaginatedAttachmentClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAttachmentClient ClearParameters()

Returns

PaginatedAttachmentClient

The current PaginatedAttachmentClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAttachmentClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAttachmentClient

The current PaginatedAttachmentClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Attachment resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public AttachmentClient IncludeEvent()

Returns

AttachmentClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAttachmentClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAttachmentClient

The current PaginatedAttachmentClient instance.

OrderByContentType()

Sort response items by the ContentType attribute.

public AttachmentClient OrderByContentType()

Returns

AttachmentClient

OrderByContentTypeDescending()

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

public AttachmentClient OrderByContentTypeDescending()

Returns

AttachmentClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public AttachmentClient OrderByCreatedAt()

Returns

AttachmentClient

OrderByCreatedAtDescending()

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

public AttachmentClient OrderByCreatedAtDescending()

Returns

AttachmentClient

OrderByDescription()

Sort response items by the Description attribute.

public AttachmentClient OrderByDescription()

Returns

AttachmentClient

OrderByDescriptionDescending()

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

public AttachmentClient OrderByDescriptionDescending()

Returns

AttachmentClient

OrderByFileSize()

Sort response items by the FileSize attribute.

public AttachmentClient OrderByFileSize()

Returns

AttachmentClient

OrderByFileSizeDescending()

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

public AttachmentClient OrderByFileSizeDescending()

Returns

AttachmentClient

OrderByName()

Sort response items by the Name attribute.

public AttachmentClient OrderByName()

Returns

AttachmentClient

OrderByNameDescending()

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

public AttachmentClient OrderByNameDescending()

Returns

AttachmentClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public AttachmentClient OrderByUpdatedAt()

Returns

AttachmentClient

OrderByUpdatedAtDescending()

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

public AttachmentClient OrderByUpdatedAtDescending()

Returns

AttachmentClient

PerPage(int)

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

public PaginatedAttachmentClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAttachmentClient

The current PaginatedAttachmentClient instance.

WhereContentType(string)

Query response items by the ContentType attribute.

public AttachmentClient WhereContentType(string value)

Parameters

value string

Returns

AttachmentClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public AttachmentClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

AttachmentClient

WhereDescription(string)

Query response items by the Description attribute.

public AttachmentClient WhereDescription(string value)

Parameters

value string

Returns

AttachmentClient

WhereFileSize(int)

Query response items by the FileSize attribute.

public AttachmentClient WhereFileSize(int value)

Parameters

value int

Returns

AttachmentClient

WhereName(string)

Query response items by the Name attribute.

public AttachmentClient WhereName(string value)

Parameters

value string

Returns

AttachmentClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public AttachmentClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

AttachmentClient

WithId(string)

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

public AttachmentClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AttachmentClient

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