Class AttachmentClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Attachment resource.

public class AttachmentClient : SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>

Inheritance

object

ResourceClient<Attachment>

SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>

AttachmentClient

Inherited Members

SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>.PatchAsync(Attachment, CancellationToken)

SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>.PatchAsync(JsonApiDocument<AttachmentResource>, CancellationToken)

SingletonResourceClient<Attachment, AttachmentResource, AttachmentResponse>.DeleteAsync(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

AttachmentClient(HttpClient, Uri)

Client for interacting with the Attachment resource.

public AttachmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AttachmentClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AttachmentClient

The current AttachmentClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AttachmentClient ClearParameters()

Returns

AttachmentClient

The current AttachmentClient instance.

GetAsync(CancellationToken)

Fetches the Attachment resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttachmentResponse>

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

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