Class ServiceTypePathClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ServiceTypePath resource.

public class ServiceTypePathClient : SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>

Inheritance

object

ResourceClient<ServiceTypePath>

SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>

ServiceTypePathClient

Inherited Members

SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>.PatchAsync(ServiceTypePath, CancellationToken)

SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>.PatchAsync(JsonApiDocument<ServiceTypePathResource>, CancellationToken)

SingletonResourceClient<ServiceTypePath, ServiceTypePathResource, ServiceTypePathResponse>.DeleteAsync(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

ServiceTypePathClient(HttpClient, Uri)

Client for interacting with the ServiceTypePath resource.

public ServiceTypePathClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ServiceTypePathClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ServiceTypePathClient

The current ServiceTypePathClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ServiceTypePathClient ClearParameters()

Returns

ServiceTypePathClient

The current ServiceTypePathClient instance.

GetAsync(CancellationToken)

Fetches the ServiceTypePath resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ServiceTypePathResponse>

A task representing the asynchronous operation, containing the ServiceTypePath resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.