Class Event

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Event resource.

public record Event : IEquatable<Event>

Inheritance

object

Event

Implements

IEquatable<Event>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Event()

public Event()

Event(Event)

protected Event(Event original)

Parameters

original Event

Properties

AttendanceRequestsEnabled

This is a group setting that applies to all the events in the group.
If selected, an email will be sent to the primary email address of the group leader
60 minutes before the event start time, asking them to report attendance.

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

Property Value

bool?

AutomatedReminderEnabled

If true, we send an event remind some specified time before the event starts
to all members in the group.

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

Property Value

bool?

Canceled

Whether or not the event has been canceled.

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

Property Value

bool?

CanceledAt

The date and time the event was canceled.

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

Property Value

DateTime?

Description

A longform description of the event. Can contain HTML markup.

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

Property Value

string

EndsAt

The date and time the event 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

Image

The image for the event.

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

Property Value

Image

LocationTypePreference

Either "physical" or "virtual".

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

Property Value

string

MultiDay

true if the event spans multiple days. Otherwise false.

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

Property Value

bool?

Name

The name/title of the event.

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

Property Value

string

RemindersSent

true if reminders have been sent for this event. Otherwise false.

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

Property Value

bool?

RemindersSentAt

The date and time reminders were sent for this event.

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

Property Value

DateTime?

Repeating

true if the event is a repeating event. Otherwise false.

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

Property Value

bool?

StartsAt

The date and time the event starts.

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

Property Value

DateTime?

VirtualLocationUrl

The URL for the virtual location. Typically we don't show this URL unless
unless the location_type_preference is "virtual".

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

Property Value

string

VisitorsCount

The number of visitors who attended the event. These are people who are not
members of the group.

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

Property Value

int?

Methods

Equals(Event?)

public virtual bool Equals(Event? other)

Parameters

other Event

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

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

Parameters

left Event

right Event

Returns

bool

operator !=(Event?, Event?)

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

Parameters

left Event

right Event

Returns

bool