Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the structure of the OkHi location object once an address has been successfully created by the user.

Hierarchy

  • OkHiLocation

Index

Properties

Optional city

city: undefined | string

A user's city

Optional country

country: undefined | string

A user's country

Optional directions

directions: undefined | string

User generated directions to the location.

Optional displayTitle

displayTitle: undefined | string

A formatted location information

Optional id

id: undefined | string

The OkHi's locationId. Usually obtained once an address has been successfully created by the user.

lat

lat: number

The latitude of the location.

lon

lon: number

The longitude of the location.

Optional otherInformation

otherInformation: undefined | string

User generated meta information about the location, how to access it and any other relevant notes.

Optional photo

photo: undefined | string

A link to the location's gate photo.

Optional placeId

placeId: undefined | string

The id of a common residential or geological space such as apartment building or office block.

Optional plusCode

plusCode: undefined | string

Geocode system for identifying an area anywhere on the Earth. See https://plus.codes/

Optional propertyName

propertyName: undefined | string

The location's property name.

Optional propertyNumber

propertyNumber: undefined | string

The location's property number.

Optional state

state: undefined | string

A user's state

Optional streetName

streetName: undefined | string

The location's street name.

Optional streetViewPanoId

streetViewPanoId: undefined | string

A Google's StreetView Panorama Id, if the address was created using Google StreetView. See: https://developers.google.com/maps/documentation/javascript/streetview

Optional streetViewPanoUrl

streetViewPanoUrl: undefined | string

A Google's StreetView Panorama Url, if the address was created using Google StreetView. See: https://developers.google.com/maps/documentation/javascript/streetview

Optional subtitle

subtitle: undefined | string

A string that can be used to render meta information about the location.

Optional title

title: undefined | string

A string that can be used to render information about the location.

Optional url

url: undefined | string

A link to the user's address visible on browser or desktop.

Optional userId

userId: undefined | string

The OkHi's userId. Usually obtained after a user successfully creates an OkHi address.

Legend

  • Constructor
  • Property
  • Property
  • Inherited property
  • Static property

Generated using TypeDoc