Class AttachmentActivityClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AttachmentActivity resource.

public class AttachmentActivityClient : SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>

Inheritance

object

ResourceClient<AttachmentActivity>

SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>

AttachmentActivityClient

Inherited Members

SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>.PatchAsync(AttachmentActivity, CancellationToken)

SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>.PatchAsync(JsonApiDocument<AttachmentActivityResource>, CancellationToken)

SingletonResourceClient<AttachmentActivity, AttachmentActivityResource, AttachmentActivityResponse>.DeleteAsync(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

AttachmentActivityClient(HttpClient, Uri)

Client for interacting with the AttachmentActivity resource.

public AttachmentActivityClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AttachmentActivityClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AttachmentActivityClient

The current AttachmentActivityClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AttachmentActivityClient ClearParameters()

Returns

AttachmentActivityClient

The current AttachmentActivityClient instance.

GetAsync(CancellationToken)

Fetches the AttachmentActivity resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentActivityResponse>

A task representing the asynchronous operation, containing the AttachmentActivity resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.