Class Address

Namespace

Crews.PlanningCenter.Api.Calendar

Assembly

Crews.PlanningCenter.Api.dll

Represents a physical address for a Person resource's contact data.

[ExcludeFromCodeCoverage(Justification = "This type is a DTO with no logic to test.")]
public record Address : IEquatable<Address>

Inheritance

object

Address

Implements

IEquatable<Address>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Address()

public Address()

Address(Address)

protected Address(Address original)

Parameters

original Address

Properties

City

The city of the address.

[JsonPropertyName("city")]
public string? City { get; init; }

Property Value

string

CountryCode

The ISO country code of the address (e.g. "US" for United States).

[JsonPropertyName("country_code")]
public string? CountryCode { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Location

The location or context of the address (e.g. "home", "work").

[JsonPropertyName("location")]
public string? Location { get; init; }

Property Value

string

Primary

Whether this address is the primary contact method for the person.

[JsonPropertyName("primary")]
public bool? Primary { get; init; }

Property Value

bool?

State

The state or province of the address.

[JsonPropertyName("state")]
public string? State { get; init; }

Property Value

string

Street

The full street address.

[JsonPropertyName("street")]
public string? Street { get; init; }

Property Value

string

StreetLine1

The first line of the street address.

[JsonPropertyName("street_line_1")]
public string? StreetLine1 { get; init; }

Property Value

string

StreetLine2

The second line of the street address (e.g. apartment or suite number).

[JsonPropertyName("street_line_2")]
public string? StreetLine2 { get; init; }

Property Value

string

Zip

The postal code of the address.

[JsonPropertyName("zip")]
public string? Zip { get; init; }

Property Value

string

Methods

Equals(Address?)

public virtual bool Equals(Address? other)

Parameters

other Address

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

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

Parameters

left Address

right Address

Returns

bool

operator !=(Address?, Address?)

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

Parameters

left Address

right Address

Returns

bool