Class PaginatedResourceSuggestionClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ResourceSuggestion collection resources.

public class PaginatedResourceSuggestionClient : PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>

Inheritance

object

ResourceClient<ResourceSuggestion>

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>

PaginatedResourceSuggestionClient

Inherited Members

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>.PerPage(int)

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>.Offset(int)

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>.Filter(string)

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>.PostAsync(ResourceSuggestion, CancellationToken)

PaginatedResourceClient<ResourceSuggestion, ResourceSuggestionResource, ResourceSuggestionCollectionResponse, ResourceSuggestionResponse>.PostAsync(JsonApiDocument<ResourceSuggestionResource>, CancellationToken)

ResourceClient<ResourceSuggestion>.AddQueryParameter(string, string)

ResourceClient<ResourceSuggestion>.ReplaceQueryParameter(string, string)

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

PaginatedResourceSuggestionClient(HttpClient, Uri)

Client for interacting with ResourceSuggestion collection resources.

public PaginatedResourceSuggestionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedResourceSuggestionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedResourceSuggestionClient

The current PaginatedResourceSuggestionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedResourceSuggestionClient ClearParameters()

Returns

PaginatedResourceSuggestionClient

The current PaginatedResourceSuggestionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedResourceSuggestionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedResourceSuggestionClient

The current PaginatedResourceSuggestionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ResourceSuggestion resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceSuggestionCollectionResponse>

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedResourceSuggestionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedResourceSuggestionClient

The current PaginatedResourceSuggestionClient instance.

PerPage(int)

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

public PaginatedResourceSuggestionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedResourceSuggestionClient

The current PaginatedResourceSuggestionClient instance.

WithId(string)

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

public ResourceSuggestionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ResourceSuggestionClient

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