Class PaginatedFeedClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Feed collection resources.

public class PaginatedFeedClient : PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>

Inheritance

object

ResourceClient<Feed>

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>

PaginatedFeedClient

Inherited Members

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>.PerPage(int)

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>.Offset(int)

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>.Filter(string)

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>.PostAsync(Feed, CancellationToken)

PaginatedResourceClient<Feed, FeedResource, FeedCollectionResponse, FeedResponse>.PostAsync(JsonApiDocument<FeedResource>, 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

PaginatedFeedClient(HttpClient, Uri)

Client for interacting with Feed collection resources.

public PaginatedFeedClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFeedClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFeedClient

The current PaginatedFeedClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFeedClient ClearParameters()

Returns

PaginatedFeedClient

The current PaginatedFeedClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFeedClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFeedClient

The current PaginatedFeedClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Feed resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FeedCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFeedClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFeedClient

The current PaginatedFeedClient instance.

OrderByName()

Sort response items by the Name attribute.

public FeedClient OrderByName()

Returns

FeedClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public FeedClient OrderByNameDescending()

Returns

FeedClient

PerPage(int)

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

public PaginatedFeedClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFeedClient

The current PaginatedFeedClient instance.

WhereFeedType(string)

Query response items by the FeedType attribute.

public FeedClient WhereFeedType(string value)

Parameters

value string

Returns

FeedClient

WhereSourceId(string)

Query response items by the SourceId attribute.

public FeedClient WhereSourceId(string value)

Parameters

value string

Returns

FeedClient

WithId(string)

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

public FeedClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FeedClient

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