Class Enrollment

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Enrollment resource.

public record Enrollment : IEquatable<Enrollment>

Inheritance

object

Enrollment

Implements

IEquatable<Enrollment>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Enrollment()

public Enrollment()

Enrollment(Enrollment)

protected Enrollment(Enrollment original)

Parameters

original Enrollment

Properties

AutoClosed

Whether or not enrollment has been closed automatically due to set limits

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

Property Value

bool?

AutoClosedReason

Brief description as to which limit automatically closed enrollment

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

Property Value

string

DateLimit

Date when enrollment should automatically close

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

Property Value

string

DateLimitReached

Whether or not the date_limit has been reached

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

Property Value

bool?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

MemberLimit

Total number of members allowed before enrollment should automatically close

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

Property Value

int?

MemberLimitReached

Whether or not the member_limit has been reached

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

Property Value

bool?

Status

Current enrollment status. Possible values:
* open - strategy is not closed and no limits have been reached
* closed - strategy is closed or limits have been reached
* full - member limit has been reached
* private - group is unlisted

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

Property Value

string

Strategy

Sign up strategy. Possible values: request_to_join, open_signup, or closed

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

Property Value

string

Methods

Equals(Enrollment?)

public virtual bool Equals(Enrollment? other)

Parameters

other Enrollment

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

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

Parameters

left Enrollment

right Enrollment

Returns

bool

operator !=(Enrollment?, Enrollment?)

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

Parameters

left Enrollment

right Enrollment

Returns

bool