Class ResourceSuggestionClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ResourceSuggestion resource.

public class ResourceSuggestionClient : SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>

Inheritance

object

ResourceClient<ResourceSuggestion>

SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>

ResourceSuggestionClient

Inherited Members

SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>.PatchAsync(ResourceSuggestion, CancellationToken)

SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>.PatchAsync(JsonApiDocument<ResourceSuggestionResource>, CancellationToken)

SingletonResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionResponse>.DeleteAsync(CancellationToken)

ResourceClient<ResourceSuggestion>.AddQueryParameter(string, string)

ResourceClient<ResourceSuggestion>.ReplaceQueryParameter(string, string)

ResourceClient<ResourceSuggestion>.AddCustomParameter(string, string)

ResourceClient<ResourceSuggestion>.ClearParameters()

ResourceClient<ResourceSuggestion>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ResourceSuggestion>.Uri

ResourceClient<ResourceSuggestion>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceSuggestionClient(HttpClient, Uri)

Client for interacting with the ResourceSuggestion resource.

public ResourceSuggestionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Resource

Associated Resource.

public ResourceClient Resource { get; }

Property Value

ResourceClient

Methods

GetAsync(CancellationToken)

Fetches the ResourceSuggestion resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceSuggestionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResource()

Include related Resource resources in the response.

public ResourceSuggestionClient IncludeResource()

Returns

ResourceSuggestionClient