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>.AddCustomParameter(string, string)

ResourceClient<Theme>.ClearParameters()

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

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.

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.