Class PaginatedConflictClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedConflictClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedConflictClient

The current PaginatedConflictClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedConflictClient ClearParameters()

Returns

PaginatedConflictClient

The current PaginatedConflictClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedConflictClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedConflictClient

The current PaginatedConflictClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedConflictClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedConflictClient

The current PaginatedConflictClient instance.

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

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedConflictClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedConflictClient

The current PaginatedConflictClient instance.

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.