Class ListClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the List resource.

public class ListClient : SingletonResourceClient<List, ListResource, ListResponse>

Inheritance

object

ResourceClient<List>

SingletonResourceClient<List, ListResource, ListResponse>

ListClient

Inherited Members

SingletonResourceClient<List, ListResource, ListResponse>.GetAsync(CancellationToken)

SingletonResourceClient<List, ListResource, ListResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<List, ListResource, ListResponse>.PatchAsync(List, CancellationToken)

SingletonResourceClient<List, ListResource, ListResponse>.PatchAsync(JsonApiDocument<ListResource>, CancellationToken)

SingletonResourceClient<List, ListResource, ListResponse>.DeleteAsync(CancellationToken)

ResourceClient<List>.AddQueryParameter(string, string)

ResourceClient<List>.ReplaceQueryParameter(string, string)

ResourceClient<List>.AddCustomParameter(string, string)

ResourceClient<List>.ClearParameters()

ResourceClient<List>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<List>.Uri

ResourceClient<List>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ListClient(HttpClient, Uri)

Client for interacting with the List resource.

public ListClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Campus

Associated Campus.

public PaginatedCampusClient Campus { get; }

Property Value

PaginatedCampusClient

Category

Associated Category.

public ListCategoryClient Category { get; }

Property Value

ListCategoryClient

CreatedBy

Associated CreatedBy.

public PersonClient CreatedBy { get; }

Property Value

PersonClient

ListResults

Associated ListResults.

public PaginatedListResultClient ListResults { get; }

Property Value

PaginatedListResultClient

MailchimpSyncStatus

Associated MailchimpSyncStatus.

public PaginatedMailchimpSyncStatusClient MailchimpSyncStatus { get; }

Property Value

PaginatedMailchimpSyncStatusClient

Owner

Associated Owner.

[Obsolete("This endpoint is deprecated and may be removed in a future release.")]
public PersonClient Owner { get; }

Property Value

PersonClient

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

Rules

Associated Rules.

public PaginatedRuleClient Rules { get; }

Property Value

PaginatedRuleClient

Shares

Associated Shares.

public PaginatedListShareClient Shares { get; }

Property Value

PaginatedListShareClient

Star

Associated Star.

public ListStarClient Star { get; }

Property Value

ListStarClient

UpdatedBy

Associated UpdatedBy.

public PersonClient UpdatedBy { get; }

Property Value

PersonClient

Methods

GetAsync(CancellationToken)

Fetches the List resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListResponse>

A task representing the asynchronous operation, containing the List resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampus()

Include related Campus resources in the response.

public ListClient IncludeCampus()

Returns

ListClient

IncludeCategory()

Include related Category resources in the response.

public ListClient IncludeCategory()

Returns

ListClient

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public ListClient IncludeCreatedBy()

Returns

ListClient

IncludeMailchimpSyncStatus()

Include related MailchimpSyncStatus resources in the response.

public ListClient IncludeMailchimpSyncStatus()

Returns

ListClient

IncludeOwner()

Include related Owner resources in the response.

public ListClient IncludeOwner()

Returns

ListClient

IncludePeople()

Include related People resources in the response.

public ListClient IncludePeople()

Returns

ListClient

IncludeRules()

Include related Rules resources in the response.

public ListClient IncludeRules()

Returns

ListClient

IncludeShares()

Include related Shares resources in the response.

public ListClient IncludeShares()

Returns

ListClient

IncludeUpdatedBy()

Include related UpdatedBy resources in the response.

public ListClient IncludeUpdatedBy()

Returns

ListClient

MailchimpSyncAsync(CancellationToken)

Sync a List to Mailchimp. (Mailchimp integration must already be configured for this organization.)

public Task MailchimpSyncAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

RunAsync(CancellationToken)

Run a List to update its results.

public Task RunAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task