Class PaginatedThemeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Theme collection resources.

public class PaginatedThemeClient : PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>

Inheritance

object

ResourceClient<Theme>

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>

PaginatedThemeClient

Inherited Members

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>.PerPage(int)

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>.Offset(int)

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>.Filter(string)

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>.PostAsync(Theme, CancellationToken)

PaginatedResourceClient<Theme, ThemeResource, ThemeCollectionResponse, ThemeResponse>.PostAsync(JsonApiDocument<ThemeResource>, CancellationToken)

ResourceClient<Theme>.AddQueryParameter(string, string)

ResourceClient<Theme>.ReplaceQueryParameter(string, string)

ResourceClient<Theme>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Theme>.Uri

ResourceClient<Theme>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedThemeClient(HttpClient, Uri)

Client for interacting with Theme collection resources.

public PaginatedThemeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedThemeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedThemeClient

The current PaginatedThemeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedThemeClient ClearParameters()

Returns

PaginatedThemeClient

The current PaginatedThemeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedThemeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedThemeClient

The current PaginatedThemeClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Theme resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ThemeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedThemeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedThemeClient

The current PaginatedThemeClient instance.

PerPage(int)

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

public PaginatedThemeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedThemeClient

The current PaginatedThemeClient instance.

WithId(string)

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

public ThemeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ThemeClient

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