Class PaginatedServiceTypePathClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ServiceTypePath collection resources.

public class PaginatedServiceTypePathClient : PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>

Inheritance

object

ResourceClient<ServiceTypePath>

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>

PaginatedServiceTypePathClient

Inherited Members

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>.PerPage(int)

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>.Offset(int)

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>.Filter(string)

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>.PostAsync(ServiceTypePath, CancellationToken)

PaginatedResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathCollectionResponse, ServiceTypePathResponse>.PostAsync(JsonApiDocument<ServiceTypePathResource>, CancellationToken)

ResourceClient<ServiceTypePath>.AddQueryParameter(string, string)

ResourceClient<ServiceTypePath>.ReplaceQueryParameter(string, string)

ResourceClient<ServiceTypePath>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ServiceTypePath>.Uri

ResourceClient<ServiceTypePath>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedServiceTypePathClient(HttpClient, Uri)

Client for interacting with ServiceTypePath collection resources.

public PaginatedServiceTypePathClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedServiceTypePathClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedServiceTypePathClient

The current PaginatedServiceTypePathClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedServiceTypePathClient ClearParameters()

Returns

PaginatedServiceTypePathClient

The current PaginatedServiceTypePathClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedServiceTypePathClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedServiceTypePathClient

The current PaginatedServiceTypePathClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ServiceTypePath resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTypePathCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedServiceTypePathClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedServiceTypePathClient

The current PaginatedServiceTypePathClient instance.

PerPage(int)

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

public PaginatedServiceTypePathClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedServiceTypePathClient

The current PaginatedServiceTypePathClient instance.

WithId(string)

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

public ServiceTypePathClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ServiceTypePathClient

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