Class Item

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Item resource.

public record Item : IEquatable<Item>

Inheritance

object

Item

Implements

IEquatable<Item>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Item()

public Item()

Item(Item)

protected Item(Item original)

Parameters

original Item

Properties

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?

CustomArrangementSequence

An array of strings containing a label and a number describing the section:

['Verse 1', 'Chorus 1', 'Verse 2']

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("custom_arrangement_sequence")]
public JsonArray? CustomArrangementSequence { get; init; }

Property Value

JsonArray

CustomArrangementSequenceFull

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("custom_arrangement_sequence_full")]
public JsonArray? CustomArrangementSequenceFull { get; init; }

Property Value

JsonArray

CustomArrangementSequenceShort

Planning Center does not provide a description for this attribute.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("custom_arrangement_sequence_short")]
public JsonArray? CustomArrangementSequenceShort { get; init; }

Property Value

JsonArray

Description

Planning Center does not provide a description for this attribute.

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

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

HtmlDetails

Planning Center does not provide a description for this attribute.

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

Property Value

string

ItemType

There are 4 possible values:

- song: The item is a song

- header: The item is a header

- media: The item is a piece of media

- item: The default item type

This value can only be set when an item is created. The only value that you can pass is header. If no value is passed then item will be used. To create a media item you'll attach a video media to the item, and to create a song item, you'll attach a song.

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

Property Value

string

KeyName

Planning Center does not provide a description for this attribute.

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

Property Value

string

Length

Planning Center does not provide a description for this attribute.

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

Property Value

int?

Sequence

Planning Center does not provide a description for this attribute.

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

Property Value

int?

ServicePosition

There are 3 possible values:

- pre: the item happens before the service starts

- post: the item happens after the service ends

- during: the item happens during the service

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

Property Value

string

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

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

public virtual bool Equals(Item? other)

Parameters

other Item

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

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

Parameters

left Item

right Item

Returns

bool

operator !=(Item?, Item?)

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

Parameters

left Item

right Item

Returns

bool