Class PaginatedConflictClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Conflict collection resources.

public class PaginatedConflictClient : PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>

Inheritance

object

ResourceClient<Conflict>

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>

PaginatedConflictClient

Inherited Members

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>.PerPage(int)

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>.Offset(int)

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>.Filter(string)

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>.PostAsync(Conflict, CancellationToken)

PaginatedResourceClient<Conflict, ConflictResource, ConflictCollectionResponse, ConflictResponse>.PostAsync(JsonApiDocument<ConflictResource>, CancellationToken)

ResourceClient<Conflict>.AddQueryParameter(string, string)

ResourceClient<Conflict>.ReplaceQueryParameter(string, string)

ResourceClient<Conflict>.AddCustomParameter(string, string)

ResourceClient<Conflict>.ClearParameters()

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

PaginatedConflictClient(HttpClient, Uri)

Client for interacting with Conflict collection resources.

public PaginatedConflictClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Conflict resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConflictCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of Conflict resources.

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

OrderByResolvedAt()

Sort response items by the ResolvedAt attribute.

public ConflictClient OrderByResolvedAt()

Returns

ConflictClient

OrderByResolvedAtDescending()

Sort response items by the ResolvedAt attribute. Use reverse order.

public ConflictClient OrderByResolvedAtDescending()

Returns

ConflictClient

WithId(string)

Creates a new instance of a Conflict client for a specific resource ID.

public ConflictClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ConflictClient

A new instance of the resource client for the specified resource ID.