Class IntegrationLinkClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the IntegrationLink resource.

public class IntegrationLinkClient : SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>

Inheritance

object

ResourceClient<IntegrationLink>

SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>

IntegrationLinkClient

Inherited Members

SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>.GetAsync(CancellationToken)

SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>.PatchAsync(IntegrationLink, CancellationToken)

SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>.PatchAsync(JsonApiDocument<IntegrationLinkResource>, CancellationToken)

SingletonResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkResponse>.DeleteAsync(CancellationToken)

ResourceClient<IntegrationLink>.AddQueryParameter(string, string)

ResourceClient<IntegrationLink>.ReplaceQueryParameter(string, string)

ResourceClient<IntegrationLink>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<IntegrationLink>.Uri

ResourceClient<IntegrationLink>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

IntegrationLinkClient(HttpClient, Uri)

Client for interacting with the IntegrationLink resource.

public IntegrationLinkClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public IntegrationLinkClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

IntegrationLinkClient

The current IntegrationLinkClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public IntegrationLinkClient ClearParameters()

Returns

IntegrationLinkClient

The current IntegrationLinkClient instance.

GetAsync(CancellationToken)

Fetches the IntegrationLink resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<IntegrationLinkResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.