AFCore/com.advantahealth.api.locations.model/FavoriteLocation

FavoriteLocation

data class FavoriteLocation(val id: Long, val locationId: Long, val locationGlobalId: String?, val favoriteType: LocationFavoriteType, val favoriteTypeCode: Int, val isPrimary: Boolean, val notes: String?, val locationName: String?, val addressLine1: String?, val addressLine2: String?, val city: String?, val stateProvince: String?, val postalCode: String?, val phone: String?, val latitude: Double?, val longitude: Double?, val brandName: String?, val pinImageId: Long?, val pinImageUrl: String?, val geofenceRadiusMeters: Double?, val dwellThresholdMinutes: Int?, val supportsGuestPass: Boolean, val legacyClubId: Long?, val createdAt: String?, val modifiedAt: String?, val categoryCode: String? = null)

A location the member has a favorite relationship with, joined with the location's own data - the Locations API's replacement for the legacy VerifiedClubs list (Facility). Returned by Locations.getFavorites and by every favorite mutation.

Favorites mix gyms and retail stores: use isFitness wherever only gyms count. The list also holds excluded and muted locations - favoriteType is LocationFavoriteType.FAVORITE only for an active favorite.

Constructors

FavoriteLocation

constructor(id: Long, locationId: Long, locationGlobalId: String?, favoriteType: LocationFavoriteType, favoriteTypeCode: Int, isPrimary: Boolean, notes: String?, locationName: String?, addressLine1: String?, addressLine2: String?, city: String?, stateProvince: String?, postalCode: String?, phone: String?, latitude: Double?, longitude: Double?, brandName: String?, pinImageId: Long?, pinImageUrl: String?, geofenceRadiusMeters: Double?, dwellThresholdMinutes: Int?, supportsGuestPass: Boolean, legacyClubId: Long?, createdAt: String?, modifiedAt: String?, categoryCode: String? = null)

Types

Companion

object Companion

Properties

addressLine1

val addressLine1: String?

Address line 1.

addressLine2

val addressLine2: String?

Address line 2.

brandName

val brandName: String?

Brand the location belongs to, or null.

categoryCode

val categoryCode: String?

The location's category code - "FITNESS" for gyms and clubs, "RETAIL" for stores - or null when it has none. A member's favorites mix both; use isFitness where only gyms count.

city

val city: String?

City.

createdAt

val createdAt: String?

ISO-8601 creation timestamp of the favorite record.

dwellThresholdMinutes

val dwellThresholdMinutes: Int?

Minimum dwell in minutes for a visit to count, or null when the location defines none.

favoriteType

val favoriteType: LocationFavoriteType

Typed relationship; LocationFavoriteType.UNRECOGNIZED for codes this SDK version does not know.

favoriteTypeCode

val favoriteTypeCode: Int

The verbatim wire code, kept so no server state is lost when favoriteType is LocationFavoriteType.UNRECOGNIZED.

geofenceRadiusMeters

val geofenceRadiusMeters: Double?

Geofence radius in meters, or null when the location defines none.

val id: Long

Primary key of the favorite record. Informational only - every mutation is addressed by locationId.

isFitness

val isFitness: Boolean

Whether this is a fitness location (a gym or club) - the only kind that earns gym visits, can be monitored for automatic visits and should be offered for self-reports. A location backed by a legacy club counts as fitness even when the server sent no category, because only fitness locations are enrolled as clubs.

isPrimary

val isPrimary: Boolean

Whether this is the member's primary location.

latitude

val latitude: Double?

Latitude in decimal degrees, or null when unknown.

legacyClubId

val legacyClubId: Long?

Id of the legacy VerifiedClubs record this location maps to, or null when there is none.

locationGlobalId

val locationGlobalId: String?

Global id of the location as a GUID string; the server sends the all-zeros GUID when upstream has none.