Class ConflictClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Conflict resource.

public class ConflictClient : SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>

Inheritance

object

ResourceClient<Conflict>

SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>

ConflictClient

Inherited Members

SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>.PatchAsync(Conflict, CancellationToken)

SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>.PatchAsync(JsonApiDocument<ConflictResource>, CancellationToken)

SingletonResourceClient<Conflict, ConflictResource, ConflictResponse>.DeleteAsync(CancellationToken)

ResourceClient<Conflict>.AddQueryParameter(string, string)

ResourceClient<Conflict>.ReplaceQueryParameter(string, string)

ResourceClient<Conflict>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Conflict>.Uri

ResourceClient<Conflict>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConflictClient(HttpClient, Uri)

Client for interacting with the Conflict resource.

public ConflictClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

ResolvedBy

Associated ResolvedBy.

public PersonClient ResolvedBy { get; }

Property Value

PersonClient

Resource

Associated Resource.

public ResourceClient Resource { get; }

Property Value

ResourceClient

Winner

Associated Winner.

public EventClient Winner { get; }

Property Value

EventClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ConflictClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ConflictClient

The current ConflictClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ConflictClient ClearParameters()

Returns

ConflictClient

The current ConflictClient instance.

GetAsync(CancellationToken)

Fetches the Conflict resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConflictResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeResolvedBy()

Include related ResolvedBy resources in the response.

public ConflictClient IncludeResolvedBy()

Returns

ConflictClient

IncludeResource()

Include related Resource resources in the response.

public ConflictClient IncludeResource()

Returns

ConflictClient

IncludeWinner()

Include related Winner resources in the response.

public ConflictClient IncludeWinner()

Returns

ConflictClient