Class EventInstance

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the EventInstance resource.

public record EventInstance : IEquatable<EventInstance>

Inheritance

object

EventInstance

Implements

IEquatable<EventInstance>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

EventInstance()

public EventInstance()

EventInstance(EventInstance)

protected EventInstance(EventInstance original)

Parameters

original EventInstance

Properties

AllDayEvent

Indicates whether event instance lasts all day

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

Property Value

bool?

ChurchCenterUrl

The URL for the event on Church Center

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

Property Value

string

CreatedAt

UTC time at which the event instance was created

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

Property Value

DateTime?

Description

A rich text public-facing summary of the event

Only available when requested with the ?fields param

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

Property Value

string

EndsAt

UTC time at which the event instance ends

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

Property Value

DateTime?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

ImageUrl

Path to where the event image is stored

Only available when requested with the ?fields param

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

Property Value

string

Kind

The type of event: standard or blockout

Only available when requested with the ?fields param

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

Property Value

string

Location

Representation of where the event instance takes place

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

Property Value

string

Name

Name of event. Can be overridden for specific instances

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

Property Value

string

PublishedEndsAt

Publicly visible end time

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

Property Value

string

PublishedStartsAt

Publicly visible start time

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

Property Value

string

Recurrence

For a recurring event instance, the interval of how often the event instance occurs

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

Property Value

string

RecurrenceDescription

Longer description of the event instance's recurrence pattern

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

Property Value

string

StartsAt

UTC time at which the event instance starts

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

Property Value

DateTime?

UpdatedAt

UTC time at which the event instance was updated

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

Property Value

DateTime?

Methods

Equals(EventInstance?)

public virtual bool Equals(EventInstance? other)

Parameters

other EventInstance

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

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

Parameters

left EventInstance

right EventInstance

Returns

bool

operator !=(EventInstance?, EventInstance?)

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

Parameters

left EventInstance

right EventInstance

Returns

bool