Class PaginatedAttachmentActivityClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AttachmentActivity collection resources.

public class PaginatedAttachmentActivityClient : PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>

Inheritance

object

ResourceClient<AttachmentActivity>

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>

PaginatedAttachmentActivityClient

Inherited Members

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>.PerPage(int)

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>.Offset(int)

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>.Filter(string)

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>.PostAsync(AttachmentActivity, CancellationToken)

PaginatedResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityCollectionResponse, AttachmentActivityResponse>.PostAsync(JsonApiDocument<AttachmentActivityResource>, CancellationToken)

ResourceClient<AttachmentActivity>.AddQueryParameter(string, string)

ResourceClient<AttachmentActivity>.ReplaceQueryParameter(string, string)

ResourceClient<AttachmentActivity>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AttachmentActivity>.Uri

ResourceClient<AttachmentActivity>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAttachmentActivityClient(HttpClient, Uri)

Client for interacting with AttachmentActivity collection resources.

public PaginatedAttachmentActivityClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAttachmentActivityClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAttachmentActivityClient

The current PaginatedAttachmentActivityClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAttachmentActivityClient ClearParameters()

Returns

PaginatedAttachmentActivityClient

The current PaginatedAttachmentActivityClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAttachmentActivityClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAttachmentActivityClient

The current PaginatedAttachmentActivityClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of AttachmentActivity resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentActivityCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAttachmentActivityClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAttachmentActivityClient

The current PaginatedAttachmentActivityClient instance.

PerPage(int)

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

public PaginatedAttachmentActivityClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAttachmentActivityClient

The current PaginatedAttachmentActivityClient instance.