Class Plan

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Plan resource.

public record Plan : IEquatable<Plan>

Inheritance

object

Plan

Implements

IEquatable<Plan>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Plan()

public Plan()

Plan(Plan)

protected Plan(Plan original)

Parameters

original Plan

Properties

CanViewOrder

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("can_view_order")]
public bool? CanViewOrder { get; init; }

Property Value

bool?

CreatedAt

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("created_at")]
public DateTime? CreatedAt { get; init; }

Property Value

DateTime?

Dates

The full date string representing all Service Time dates.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("dates")]
public string? Dates { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

FilesExpireAt

A date 15 days after the last service time. Returns in the time zone specified in your organization's localization settings

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("files_expire_at")]
public DateTime? FilesExpireAt { get; init; }

Property Value

DateTime?

ItemsCount

The total number of items, including regular items, songs, media, and headers, that the current user can see in the plan.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("items_count")]
public int? ItemsCount { get; init; }

Property Value

int?

LastTimeAt

Returns in the time zone specified in your organization's localization settings

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("last_time_at")]
public DateTime? LastTimeAt { get; init; }

Property Value

DateTime?

MultiDay

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("multi_day")]
public bool? MultiDay { get; init; }

Property Value

bool?

NeededPositionsCount

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("needed_positions_count")]
public int? NeededPositionsCount { get; init; }

Property Value

int?

OtherTimeCount

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("other_time_count")]
public int? OtherTimeCount { get; init; }

Property Value

int?

Permissions

The current user's permissions for this plan's Service Type.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("permissions")]
public string? Permissions { get; init; }

Property Value

string

PlanNotesCount

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("plan_notes_count")]
public int? PlanNotesCount { get; init; }

Property Value

int?

PlanPeopleCount

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("plan_people_count")]
public int? PlanPeopleCount { get; init; }

Property Value

int?

PlanningCenterUrl

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("planning_center_url")]
public string? PlanningCenterUrl { get; init; }

Property Value

string

PrefersOrderView

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("prefers_order_view")]
public bool? PrefersOrderView { get; init; }

Property Value

bool?

Public

True if Public Access has been enabled.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("public")]
public bool? Public { get; init; }

Property Value

bool?

Rehearsable

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("rehearsable")]
public bool? Rehearsable { get; init; }

Property Value

bool?

RehearsalTimeCount

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("rehearsal_time_count")]
public int? RehearsalTimeCount { get; init; }

Property Value

int?

RemindersDisabled

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("reminders_disabled")]
public bool? RemindersDisabled { get; init; }

Property Value

bool?

SeriesTitle

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("series_title")]
public string? SeriesTitle { get; init; }

Property Value

string

ServiceTimeCount

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("service_time_count")]
public int? ServiceTimeCount { get; init; }

Property Value

int?

ShortDates

The shortened date string representing all Service Time dates. Months are abbreviated, and the year is omitted.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("short_dates")]
public string? ShortDates { get; init; }

Property Value

string

SortDate

A time representing the chronological first Service Time, used to sort plan chronologically. If no Service Times exist, it uses Rehearsal Times, then Other Times, then NOW. Returns in the time zone specified in your organization's localization settings

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("sort_date")]
public DateTime? SortDate { get; init; }

Property Value

DateTime?

Title

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("title")]
public string? Title { get; init; }

Property Value

string

TotalLength

The total of length of all items, excluding pre-service and post-service items.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("total_length")]
public int? TotalLength { get; init; }

Property Value

int?

UpdatedAt

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("updated_at")]
public DateTime? UpdatedAt { get; init; }

Property Value

DateTime?

Methods

Equals(Plan?)

public virtual bool Equals(Plan? other)

Parameters

other Plan

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(Plan?, Plan?)

public static bool operator ==(Plan? left, Plan? right)

Parameters

left Plan

right Plan

Returns

bool

operator !=(Plan?, Plan?)

public static bool operator !=(Plan? left, Plan? right)

Parameters

left Plan

right Plan

Returns

bool