Class HouseholdResource
- Namespace
- Crews.PlanningCenter.Api.People.V2022_01_05
- Assembly
- Crews.PlanningCenter.Api.dll
A household links people together and can have a primary contact. To add a person to an existing household, use the HouseholdMemberships endpoint.
public record HouseholdResource : JsonApiResource<Household, HouseholdRelationships>, IEquatable<JsonApiResourceIdentifier>, IEquatable<JsonApiResource>, IEquatable<JsonApiResource<Household>>, IEquatable<JsonApiResource<Household, HouseholdRelationships>>, IEquatable<HouseholdResource>
- Inheritance
-
JsonApiResourceIdentifierJsonApiResourceJsonApiResource<Household>HouseholdResource
- Implements
-
IEquatable<JsonApiResourceIdentifier>IEquatable<JsonApiResource>
- Inherited Members
-
JsonApiResource<Household, HouseholdRelationships>.ToString()JsonApiResource<Household, HouseholdRelationships>.GetHashCode()JsonApiResource<Household, HouseholdRelationships>.Equals(JsonApiResource<Household>)JsonApiResource<Household, HouseholdRelationships>.Equals(JsonApiResource<Household, HouseholdRelationships>)JsonApiResource<Household, HouseholdRelationships>.<Clone>$()JsonApiResource<Household, HouseholdRelationships>.EqualityContractJsonApiResource<Household, HouseholdRelationships>.RelationshipsJsonApiResource<Household>.Equals(JsonApiResource)JsonApiResource<Household>.Equals(JsonApiResource<Household>)JsonApiResource<Household>.AttributesJsonApiResource.Equals(JsonApiResourceIdentifier)JsonApiResource.RelationshipsJsonApiResource.LinksJsonApiResource.MetaJsonApiResourceIdentifier.IdJsonApiResourceIdentifier.LIdJsonApiResourceIdentifier.Type
Constructors
HouseholdResource()
public HouseholdResource()
HouseholdResource(HouseholdResource)
protected HouseholdResource(HouseholdResource original)
Parameters
originalHouseholdResource
Properties
EqualityContract
protected override Type EqualityContract { get; }
Property Value
Methods
Equals(HouseholdResource?)
public virtual bool Equals(HouseholdResource? other)
Parameters
otherHouseholdResource
Returns
Equals(JsonApiResource<Household, HouseholdRelationships>?)
public override sealed bool Equals(JsonApiResource<Household, HouseholdRelationships>? other)
Parameters
otherJsonApiResource<Household, HouseholdRelationships>
Returns
Equals(object?)
public override bool Equals(object? obj)
Parameters
objobject
Returns
GetHashCode()
public override int GetHashCode()
Returns
PrintMembers(StringBuilder)
protected override bool PrintMembers(StringBuilder builder)
Parameters
builderStringBuilder
Returns
ToString()
public override string ToString()
Returns
Operators
operator ==(HouseholdResource?, HouseholdResource?)
public static bool operator ==(HouseholdResource? left, HouseholdResource? right)
Parameters
leftHouseholdResourcerightHouseholdResource
Returns
operator !=(HouseholdResource?, HouseholdResource?)
public static bool operator !=(HouseholdResource? left, HouseholdResource? right)
Parameters
leftHouseholdResourcerightHouseholdResource