Class FormFieldConditionResource

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

A rule that conditionally shows a form field based on the answer given to another (trigger) field.

A condition belongs to the form_field it shows, and points at a trigger_form_field whose answer determines whether that field is displayed. A form field can have at most one condition. The trigger is matched in one of two ways:

- trigger_form_field_option — the condition is met when the answer to the trigger field is this option (used for option-based fields such as dropdowns, gender, campus, etc.).
- trigger_form_field_option_value — the condition is met when the answer to the trigger field equals this string (used for boolean custom fields).

When neither is set, the condition is met whenever the trigger field has any answer.

Conditions are created, updated, and destroyed under the form field they belong to (POST/PATCH/DELETE .../fields/{id}/form_field_conditions). The form_field and trigger_form_field must both belong to the same form, and the trigger_form_field_option must belong to the trigger_form_field. Writing requires permission to manage the form.

public record FormFieldConditionResource : JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>, IEquatable<JsonApiResourceIdentifier>, IEquatable<JsonApiResource>, IEquatable<JsonApiResource<FormFieldCondition>>, IEquatable<JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>>, IEquatable<FormFieldConditionResource>

Inheritance

object

JsonApiResourceIdentifier

JsonApiResource

JsonApiResource<FormFieldCondition>

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>

FormFieldConditionResource

Implements

IEquatable<JsonApiResourceIdentifier>

IEquatable<JsonApiResource>

IEquatable<JsonApiResource<FormFieldCondition>>

IEquatable<JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>>

IEquatable<FormFieldConditionResource>

Inherited Members

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.ToString()

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.PrintMembers(StringBuilder)

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.GetHashCode()

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.Equals(object)

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.Equals(JsonApiResource<FormFieldCondition>)

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.Equals(JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>)

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.<Clone>$()

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.EqualityContract

JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>.Relationships

JsonApiResource<FormFieldCondition>.Equals(JsonApiResource)

JsonApiResource<FormFieldCondition>.Equals(JsonApiResource<FormFieldCondition>)

JsonApiResource<FormFieldCondition>.Attributes

JsonApiResource.Equals(JsonApiResourceIdentifier)

JsonApiResource.Relationships

JsonApiResource.Links

JsonApiResource.Meta

JsonApiResourceIdentifier.Id

JsonApiResourceIdentifier.LId

JsonApiResourceIdentifier.Type

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

FormFieldConditionResource()

public FormFieldConditionResource()

FormFieldConditionResource(FormFieldConditionResource)

protected FormFieldConditionResource(FormFieldConditionResource original)

Parameters

original FormFieldConditionResource

Properties

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

Methods

Equals(FormFieldConditionResource?)

public virtual bool Equals(FormFieldConditionResource? other)

Parameters

other FormFieldConditionResource

Returns

bool

Equals(JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>?)

public override sealed bool Equals(JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>? other)

Parameters

other JsonApiResource<FormFieldCondition, FormFieldConditionRelationships>

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 override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(FormFieldConditionResource?, FormFieldConditionResource?)

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

Parameters

left FormFieldConditionResource

right FormFieldConditionResource

Returns

bool

operator !=(FormFieldConditionResource?, FormFieldConditionResource?)

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

Parameters

left FormFieldConditionResource

right FormFieldConditionResource

Returns

bool