Class PlanImportMetadataClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanImportMetadata resource.

public class PlanImportMetadataClient : SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>

Inheritance

object

ResourceClient<PlanImportMetadata>

SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>

PlanImportMetadataClient

Inherited Members

SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>.PatchAsync(PlanImportMetadata, CancellationToken)

SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>.PatchAsync(JsonApiDocument<PlanImportMetadataResource>, CancellationToken)

SingletonResourceClient<PlanImportMetadata, PlanImportMetadataResource, PlanImportMetadataResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanImportMetadata>.AddQueryParameter(string, string)

ResourceClient<PlanImportMetadata>.ReplaceQueryParameter(string, string)

ResourceClient<PlanImportMetadata>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanImportMetadata>.Uri

ResourceClient<PlanImportMetadata>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanImportMetadataClient(HttpClient, Uri)

Client for interacting with the PlanImportMetadata resource.

public PlanImportMetadataClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PlanImportMetadataClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PlanImportMetadataClient

The current PlanImportMetadataClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PlanImportMetadataClient ClearParameters()

Returns

PlanImportMetadataClient

The current PlanImportMetadataClient instance.

GetAsync(CancellationToken)

Fetches the PlanImportMetadata resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanImportMetadataResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.