Class FeedClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Feed resource.

public class FeedClient : SingletonResourceClient<Feed, FeedResource, FeedResponse>

Inheritance

object

ResourceClient<Feed>

SingletonResourceClient<Feed, FeedResource, FeedResponse>

FeedClient

Inherited Members

SingletonResourceClient<Feed, FeedResource, FeedResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Feed, FeedResource, FeedResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Feed, FeedResource, FeedResponse>.PatchAsync(Feed, CancellationToken)

SingletonResourceClient<Feed, FeedResource, FeedResponse>.PatchAsync(JsonApiDocument<FeedResource>, CancellationToken)

SingletonResourceClient<Feed, FeedResource, FeedResponse>.DeleteAsync(CancellationToken)

ResourceClient<Feed>.AddQueryParameter(string, string)

ResourceClient<Feed>.ReplaceQueryParameter(string, string)

ResourceClient<Feed>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Feed>.Uri

ResourceClient<Feed>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FeedClient(HttpClient, Uri)

Client for interacting with the Feed resource.

public FeedClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FeedClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FeedClient

The current FeedClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FeedClient ClearParameters()

Returns

FeedClient

The current FeedClient instance.

GetAsync(CancellationToken)

Fetches the Feed resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FeedResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.