Metadata

Provides access to platform metadata.

Metadata will only be fully populated when connecting into a >=R9 gateway.

By default the contents dictionaries will not be downloaded, this has to be enabled by setting isDictionaryDownloadEnabled to true in connect parameters. Setting this will download all dictionaries by default or this can be restricted by setting dictionaryDownloadList in connect parameters to string containing a comma separated list of ids for the dictionaries to download.

When connecting to a gateway version R8 or lower only the field maps will be populated for dictionaries present at the time of login.

Methods

  • getDataSourceName

    • getDataSourceName(dataSourceId: number): string

      Get a data source name from id.

      Parameters

      • dataSourceId: numberthe id of the data source

      Returns string

      the data source name, or the id converted to a string if not found

  • getSymbologyName

    • getSymbologyName(symbologyId: number): string

      Get a symbology name from id.

      Parameters

      • symbologyId: numberthe id of the symbology

      Returns string

      the symbology name, or the id converted to a string if not found

  • getDictionaryName

    • getDictionaryName(dictionaryId: number): string

      Get a dictionary name from id.

      Parameters

      • dictionaryId: numberthe id of the dictionary

      Returns string

      the dictionary name, or the id converted to a string if not found

  • getDataSourceId

    • getDataSourceId(dataSourceName: string): number

      Get a data source id from a name.

      Parameters

      • dataSourceName: stringthe name of the data source

      Returns number

      the data source id

  • getSymbologyId

    • getSymbologyId(symbologyName: string): number

      Get a symbology id from a name.

      Parameters

      • symbologyName: stringthe name of the symbology

      Returns number

      the symbology id

  • getDictionaryId

    • getDictionaryId(dictionaryName: string): number

      Get a dictionary id from a name.

      Parameters

      • dictionaryName: stringthe name of the dictionary

      Returns number

      the dictionary id

  • getDataSourceDictionary

    • getDataSourceDictionary(dataSourceId: number): Dictionary

      Get the dictionary for a data source.

      Parameters

      • dataSourceId: numberthe id of the data source

      Returns Dictionary

      the dictionary

Properties

Also in this Section