Class OrganizationClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Organization resource.

public class OrganizationClient : SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>

Inheritance

object

ResourceClient<Organization>

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>

OrganizationClient

Inherited Members

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.PatchAsync(Organization, CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.PatchAsync(JsonApiDocument<OrganizationResource>, CancellationToken)

SingletonResourceClient<Organization, OrganizationResource, OrganizationResponse>.DeleteAsync(CancellationToken)

ResourceClient<Organization>.AddQueryParameter(string, string)

ResourceClient<Organization>.ReplaceQueryParameter(string, string)

ResourceClient<Organization>.AddCustomParameter(string, string)

ResourceClient<Organization>.ClearParameters()

ResourceClient<Organization>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Organization>.Uri

ResourceClient<Organization>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OrganizationClient(HttpClient, Uri)

Client for interacting with the Organization resource.

public OrganizationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

AttachmentTypes

Associated AttachmentTypes.

public PaginatedAttachmentTypeClient AttachmentTypes { get; }

Property Value

PaginatedAttachmentTypeClient

Chat

Associated Chat.

public ChatClient Chat { get; }

Property Value

ChatClient

EmailTemplates

Associated EmailTemplates.

public PaginatedEmailTemplateClient EmailTemplates { get; }

Property Value

PaginatedEmailTemplateClient

Folders

Associated Folders.

public PaginatedFolderClient Folders { get; }

Property Value

PaginatedFolderClient

Media

Associated Media.

public PaginatedMediaClient Media { get; }

Property Value

PaginatedMediaClient

People

Associated People.

public PaginatedPersonClient People { get; }

Property Value

PaginatedPersonClient

Plans

Associated Plans.

public PaginatedOrganizationClient Plans { get; }

Property Value

PaginatedOrganizationClient

ReportTemplates

Associated ReportTemplates.

public PaginatedReportTemplateClient ReportTemplates { get; }

Property Value

PaginatedReportTemplateClient

Series

Associated Series.

public PaginatedSeriesClient Series { get; }

Property Value

PaginatedSeriesClient

ServiceTypes

Associated ServiceTypes.

public PaginatedServiceTypeClient ServiceTypes { get; }

Property Value

PaginatedServiceTypeClient

Songs

Associated Songs.

public PaginatedSongClient Songs { get; }

Property Value

PaginatedSongClient

TagGroups

Associated TagGroups.

public PaginatedTagGroupClient TagGroups { get; }

Property Value

PaginatedTagGroupClient

Teams

Associated Teams.

public PaginatedTeamClient Teams { get; }

Property Value

PaginatedTeamClient

Methods

GetAsync(CancellationToken)

Fetches the Organization resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OrganizationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.