Class EnterpriseVenue

An EnterpriseVenue is a specific place (like a mall, office building, or stadium) with one or more Floors

Hierarchy

  • default
    • EnterpriseVenue

Implements

  • EnterpriseVenue

Properties

countrycode? defaultLanguage defaultMap? externalId extra? icon? id languages links logo? mappedinWebUrl? slug topLocations? tzid?

Accessors

name

Methods

toJSON is

Properties

Optionalcountrycode

countrycode?: string

The ISO 3166-1 alpha-2 country code of the venue, if known

Eg. US or GB

defaultLanguage

defaultLanguage: Language = ...

OptionaldefaultMap

defaultMap?: string

externalId

externalId: string = ''

Optionalextra

extra?: Record<string, unknown>

Optionalicon

icon?: string

The venue's icon

Format

uri

Readonlyid

id: string

identity of the map object

languages

languages: Language[] = []

links

links: Hyperlink[] = []

Gets the links associated with this data type.

Returns

The links associated with this data type

Optionallogo

logo?: string

The venue's logo

Format

uri

OptionalmappedinWebUrl

mappedinWebUrl?: string

The base URL for Mappedin Web for this venue

Better name?

slug

slug: string = ''

OptionaltopLocations

topLocations?: string[]

Optionaltzid

tzid?: string

The venue's timezone, from the IANA Time Zone Database. Should be in the format of America/New_York

Pattern

^[A-Za-z0-9/_-]+$

Accessors

name

  • get name(): string

  • Gets the name of the EnterpriseVenue.

    Returns string

    The name of the EnterpriseVenue.

Methods

toJSON

  • toJSON(): {
        id: string;
        name: string;
    }

  • Serializes the EnterpriseVenue data to JSON.

    Returns {
        id: string;
        name: string;
    }

    An object representing the EnterpriseVenue.

    • id: string
    • name: string

Staticis

  • is(instance): instance is EnterpriseVenue

  • Checks if the provided instance is of type EnterpriseVenue.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is EnterpriseVenue

    True if the instance is a EnterpriseVenue, false otherwise.

Settings

Member Visibility

On This Page

countrycodedefaultLanguagedefaultMapexternalIdextraiconidlanguageslinkslogomappedinWebUrlslugtopLocationstzidnametoJSONis