Class PaginatedAttachmentClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

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.

IncludeZooms()

Include related Zooms resources in the response.

public AttachmentClient IncludeZooms()

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.

OrderByAttachableType()

Sort response items by the AttachableType attribute.

public AttachmentClient OrderByAttachableType()

Returns

AttachmentClient

OrderByAttachableTypeDescending()

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

public AttachmentClient OrderByAttachableTypeDescending()

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

OrderByDeletedAt()

Sort response items by the DeletedAt attribute.

public AttachmentClient OrderByDeletedAt()

Returns

AttachmentClient

OrderByDeletedAtDescending()

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

public AttachmentClient OrderByDeletedAtDescending()

Returns

AttachmentClient

OrderByFilename()

Sort response items by the Filename attribute.

public AttachmentClient OrderByFilename()

Returns

AttachmentClient

OrderByFilenameDescending()

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

public AttachmentClient OrderByFilenameDescending()

Returns

AttachmentClient

OrderByFiletype()

Sort response items by the Filetype attribute.

public AttachmentClient OrderByFiletype()

Returns

AttachmentClient

OrderByFiletypeDescending()

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

public AttachmentClient OrderByFiletypeDescending()

Returns

AttachmentClient

OrderBySize()

Sort response items by the Size attribute.

public AttachmentClient OrderBySize()

Returns

AttachmentClient

OrderBySizeDescending()

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

public AttachmentClient OrderBySizeDescending()

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.

PostAsync(Attachment, CancellationToken)

Creates a new Attachment resource asynchronously.

public Task<AttachmentResponse> PostAsync(Attachment resource, CancellationToken cancellationToken = default)

Parameters

resource Attachment

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentResponse>

A task representing the asynchronous operation, containing the created Attachment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<AttachmentResource>, CancellationToken)

Creates a new Attachment resource asynchronously.

public Task<AttachmentResponse> PostAsync(JsonApiDocument<AttachmentResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<AttachmentResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentResponse>

A task representing the asynchronous operation, containing the created Attachment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereAdministratorId(int)

Query response items by the AdministratorId attribute.

public AttachmentClient WhereAdministratorId(int value)

Parameters

value int

Returns

AttachmentClient

WhereAttachableType(string)

Query response items by the AttachableType attribute.

public AttachmentClient WhereAttachableType(string value)

Parameters

value string

Returns

AttachmentClient

WhereLicensesPurchased(int)

Query response items by the LicensesPurchased attribute.

public AttachmentClient WhereLicensesPurchased(int value)

Parameters

value int

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.