Class PaginatedRoomSetupClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2020_04_08

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with RoomSetup collection resources.

public class PaginatedRoomSetupClient : PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>

Inheritance

object

ResourceClient<RoomSetup>

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>

PaginatedRoomSetupClient

Inherited Members

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>.PerPage(int)

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>.Offset(int)

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>.Filter(string)

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>.PostAsync(RoomSetup, CancellationToken)

PaginatedResourceClient<RoomSetup, RoomSetupResource, RoomSetupCollectionResponse, RoomSetupResponse>.PostAsync(JsonApiDocument<RoomSetupResource>, CancellationToken)

ResourceClient<RoomSetup>.AddQueryParameter(string, string)

ResourceClient<RoomSetup>.ReplaceQueryParameter(string, string)

ResourceClient<RoomSetup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RoomSetup>.Uri

ResourceClient<RoomSetup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRoomSetupClient(HttpClient, Uri)

Client for interacting with RoomSetup collection resources.

public PaginatedRoomSetupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRoomSetupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRoomSetupClient

The current PaginatedRoomSetupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRoomSetupClient ClearParameters()

Returns

PaginatedRoomSetupClient

The current PaginatedRoomSetupClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRoomSetupClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRoomSetupClient

The current PaginatedRoomSetupClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of RoomSetup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RoomSetupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeContainingResource()

Include related ContainingResource resources in the response.

public RoomSetupClient IncludeContainingResource()

Returns

RoomSetupClient

IncludeResourceSuggestions()

Include related ResourceSuggestions resources in the response.

public RoomSetupClient IncludeResourceSuggestions()

Returns

RoomSetupClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRoomSetupClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRoomSetupClient

The current PaginatedRoomSetupClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public RoomSetupClient OrderByCreatedAt()

Returns

RoomSetupClient

OrderByCreatedAtDescending()

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

public RoomSetupClient OrderByCreatedAtDescending()

Returns

RoomSetupClient

OrderByName()

Sort response items by the Name attribute.

public RoomSetupClient OrderByName()

Returns

RoomSetupClient

OrderByNameDescending()

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

public RoomSetupClient OrderByNameDescending()

Returns

RoomSetupClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public RoomSetupClient OrderByUpdatedAt()

Returns

RoomSetupClient

OrderByUpdatedAtDescending()

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

public RoomSetupClient OrderByUpdatedAtDescending()

Returns

RoomSetupClient

PerPage(int)

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

public PaginatedRoomSetupClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRoomSetupClient

The current PaginatedRoomSetupClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public RoomSetupClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

RoomSetupClient

WhereName(string)

Query response items by the Name attribute.

public RoomSetupClient WhereName(string value)

Parameters

value string

Returns

RoomSetupClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public RoomSetupClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

RoomSetupClient

WithId(string)

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

public RoomSetupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RoomSetupClient

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