Class Key

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Key resource.

public record Key : IEquatable<Key>

Inheritance

object

Key

Implements

IEquatable<Key>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Key()

public Key()

Key(Key)

protected Key(Key original)

Parameters

original Key

Properties

AlternateKeys

An array of objects.


{
"name": "My Alternate Key",
"key": "B"
}


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

Property Value

string

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?

EndingKey

Possible Values:

Ab, A, A#, Bb, B, C, C#, Db, D, D#, Eb, E, F, F#, Gb, G, G#, Abm, Am, A#m, Bbm, Bm, Cm, C#m, Dbm, Dm, D#m, Ebm, Em, Fm, F#m, Gbm, Gm, G#m

To set the key to minor append m to the key. e.g. Cm

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

Property Value

string

EndingMinor

Planning Center does not provide a description for this attribute.

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

Property Value

bool?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Name

Planning Center does not provide a description for this attribute.

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

Property Value

string

StartingKey

Possible Values:

Ab, A, A#, Bb, B, C, C#, Db, D, D#, Eb, E, F, F#, Gb, G, G#, Abm, Am, A#m, Bbm, Bm, Cm, C#m, Dbm, Dm, D#m, Ebm, Em, Fm, F#m, Gbm, Gm, G#m

To set the key to minor append m to the key. e.g. Cm

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

Property Value

string

StartingMinor

Planning Center does not provide a description for this attribute.

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

Property Value

bool?

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(Key?)

public virtual bool Equals(Key? other)

Parameters

other Key

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 ==(Key?, Key?)

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

Parameters

left Key

right Key

Returns

bool

operator !=(Key?, Key?)

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

Parameters

left Key

right Key

Returns

bool