Class PaginatedServiceTypePathClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_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>.AddCustomParameter(string, string)

ResourceClient<ServiceTypePath>.ClearParameters()

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

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.

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.