Class RoomSetupClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the RoomSetup resource.

public class RoomSetupClient : SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>

Inheritance

object

ResourceClient<RoomSetup>

SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>

RoomSetupClient

Inherited Members

SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>.PatchAsync(RoomSetup, CancellationToken)

SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>.PatchAsync(JsonApiDocument<RoomSetupResource>, CancellationToken)

SingletonResourceClient<RoomSetup, RoomSetupResource, RoomSetupResponse>.DeleteAsync(CancellationToken)

ResourceClient<RoomSetup>.AddQueryParameter(string, string)

ResourceClient<RoomSetup>.ReplaceQueryParameter(string, string)

ResourceClient<RoomSetup>.AddCustomParameter(string, string)

ResourceClient<RoomSetup>.ClearParameters()

ResourceClient<RoomSetup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RoomSetup>.Uri

ResourceClient<RoomSetup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RoomSetupClient(HttpClient, Uri)

Client for interacting with the RoomSetup resource.

public RoomSetupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

ContainingResource

Associated ContainingResource.

public ContainingResourceClient ContainingResource { get; }

Property Value

ContainingResourceClient

ResourceSuggestions

Associated ResourceSuggestions.

public PaginatedResourceSuggestionClient ResourceSuggestions { get; }

Property Value

PaginatedResourceSuggestionClient

Methods

GetAsync(CancellationToken)

Fetches the RoomSetup resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RoomSetupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeContainingResource()

Include related ContainingResource resources in the response.

public RoomSetupClient IncludeContainingResource()

Returns

RoomSetupClient

IncludeResourceSuggestions()

Include related ResourceSuggestions resources in the response.

public RoomSetupClient IncludeResourceSuggestions()

Returns

RoomSetupClient