Class PaginatedIntegrationLinkClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with IntegrationLink collection resources.

public class PaginatedIntegrationLinkClient : PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>

Inheritance

object

ResourceClient<IntegrationLink>

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>

PaginatedIntegrationLinkClient

Inherited Members

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>.PerPage(int)

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>.Offset(int)

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>.Filter(string)

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>.PostAsync(IntegrationLink, CancellationToken)

PaginatedResourceClient<IntegrationLink, IntegrationLinkResource, IntegrationLinkCollectionResponse, IntegrationLinkResponse>.PostAsync(JsonApiDocument<IntegrationLinkResource>, CancellationToken)

ResourceClient<IntegrationLink>.AddQueryParameter(string, string)

ResourceClient<IntegrationLink>.ReplaceQueryParameter(string, string)

ResourceClient<IntegrationLink>.AddCustomParameter(string, string)

ResourceClient<IntegrationLink>.ClearParameters()

ResourceClient<IntegrationLink>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<IntegrationLink>.Uri

ResourceClient<IntegrationLink>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedIntegrationLinkClient(HttpClient, Uri)

Client for interacting with IntegrationLink collection resources.

public PaginatedIntegrationLinkClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of IntegrationLink resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<IntegrationLinkCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereRemoteGid(string)

Query response items by the RemoteGid attribute.

public IntegrationLinkClient WhereRemoteGid(string value)

Parameters

value string

Returns

IntegrationLinkClient

WithId(string)

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

public IntegrationLinkClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

IntegrationLinkClient

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