Mappedin JS - v6.14.0
    Preparing search index...

    Class EnterpriseVenue

    The EnterpriseVenue class holds metadata about the map, which includes the map name, supported languages, default language, top locations and more. It can be accessed using the MapData.getByType method as shown below.

    const venue = mapData.getByType('enterprise-venue');

    Refer to the EnterpriseVenue Guide for more information.

    Data Source: Enterprise - This class is only available when using CMS/Enterprise credentials (clientId/clientSecret or API keys that do NOT start with mik_). This data is not available when using Maker credentials (keys starting with mik_).

    Hierarchy

    • default
      • EnterpriseVenue

    Implements

    • EnterpriseVenue
    Index

    Properties

    countrycode? coverImage? defaultFloor? defaultLanguage externalId extra? icon? id languages links logo? mappedinWebUrl? operationHours? slug topLocations? tzid?

    Accessors

    defaultMap enterpriseType name

    Methods

    toJSON is

    Properties

    countrycode?: string

    The country code of the venue.

    coverImage?: string

    The venue's cover image.

    uri

    defaultFloor?: string

    The default floor of the venue.

    defaultLanguage: Language = ...

    The default language of the venue.

    externalId: string = ''

    The external ID of the venue.

    extra?: Record<string, unknown>

    Extra properties of the venue.

    icon?: string

    A URL to the icon of the venue.

    id: string

    The identity of the map metadata.

    languages: Language[] = []

    The languages supported by the venue.

    links: Hyperlink[] = []

    The links of the venue.

    logo?: string

    A URL to the logo of the venue.

    mappedinWebUrl?: string

    A URL to a web page with Mappedin Web for this venue.

    operationHours?: OperationHours[]

    When this venue is open.

    slug: string = ''

    The slug of the venue.

    topLocations?: string[]

    The top locations of the venue.

    tzid?: string

    The timezone ID of the venue.

    Accessors

    • get defaultMap(): string

      Returns string

      Use defaultFloor instead The default map of the venue.

    • get enterpriseType(): | "unknown"
      | "agriculture"
      | "airport"
      | "casino"
      | "city-district"
      | "convention-center"
      | "entertainment"
      | "event-centre"
      | "first-responder-building"
      | "government-building"
      | "grocery-store"
      | "healthcare"
      | "higher-education"
      | "hotel"
      | "library"
      | "manufacturing"
      | "medical-centre"
      | "mixed-use"
      | "multifamily"
      | "museum"
      | "office-building"
      | "oil-and-energy"
      | "other"
      | "parking-facility"
      | "religious-institution"
      | "resort"
      | "retail-store"
      | "schools-k-12"
      | "shopping-mall"
      | "stadium-or-arena"
      | "storage-facility"
      | "theme-park"
      | "transit"
      | "transportation-hub"
      | "warehousing"
      | undefined

      The enterprise venue type.

      Returns
          | "unknown"
          | "agriculture"
          | "airport"
          | "casino"
          | "city-district"
          | "convention-center"
          | "entertainment"
          | "event-centre"
          | "first-responder-building"
          | "government-building"
          | "grocery-store"
          | "healthcare"
          | "higher-education"
          | "hotel"
          | "library"
          | "manufacturing"
          | "medical-centre"
          | "mixed-use"
          | "multifamily"
          | "museum"
          | "office-building"
          | "oil-and-energy"
          | "other"
          | "parking-facility"
          | "religious-institution"
          | "resort"
          | "retail-store"
          | "schools-k-12"
          | "shopping-mall"
          | "stadium-or-arena"
          | "storage-facility"
          | "theme-park"
          | "transit"
          | "transportation-hub"
          | "warehousing"
          | undefined

    • get name(): string

      Gets the name of the EnterpriseVenue.

      Returns string

      The name of the EnterpriseVenue.

    Methods

    • Serializes the EnterpriseVenue data to JSON.

      Returns { __type: string; id: string; name: string }

      An object representing the 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

    Properties
    Accessors
    Methods