Class Location

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Attributes for the Location resource.

public record Location : IEquatable<Location>

Inheritance

object

Location

Implements

IEquatable<Location>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Location()

public Location()

Location(Location)

protected Location(Location original)

Parameters

original Location

Properties

DisplayPreference

This preference controls how the location is displayed to non-members for public groups and events.


Possible values: hidden, approximate, or exact

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

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

FullFormattedAddress

Ex: "1313 Disneyland Dr
Anaheim, CA 92802" (may be approximate or null)
Approximate address would be "Anaheim, CA 92802".
We obscure Canadian zip codes.

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

Property Value

string

Latitude

Ex: 33.815396 (may be approximate or null)

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("latitude")]
public decimal? Latitude { get; init; }

Property Value

decimal?

Longitude

Ex: -117.926399 (may be approximate or null)

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("longitude")]
public decimal? Longitude { get; init; }

Property Value

decimal?

Name

Ex: "Disneyland"

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

Property Value

string

Radius

The number of miles in a location's approximate address.
Will be 0 if the strategy is exact, and will be null if the strategy is hidden.

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

Property Value

int?

Strategy

The display preference strategy used for the current request, based on user permissions.
Either hidden, approximate, or exact.

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

Property Value

string

Methods

Equals(Location?)

public virtual bool Equals(Location? other)

Parameters

other Location

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

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

Parameters

left Location

right Location

Returns

bool

operator !=(Location?, Location?)

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

Parameters

left Location

right Location

Returns

bool