IMetaDataRequests

Methods

• getContentGatewayInfo

  • getContentGatewayInfo(timeoutMs?: number): IContentGatewayInfoRequestHandle

    Get information about the ContentGateway we are connected to. This is an implicit subscription; state changes for the ContentGateway will be sent as further responses. As such, the result of this function call is async iterable.

    Parameters

    • timeoutMs?: number optional timeout in milliseconds.

    Returns IContentGatewayInfoRequestHandle

    An async iterable object. When you no longer wish to receive state changes, call `delete()` on this object.

• getExchangeInfo

  • getExchangeInfo(symbol: string, timeoutMs?: number): Promise<IExchangeInfo>

    Get information about a particular exchange.

    Parameters

    • symbol: string this can be an exchange code (e.g. `Q`) or a symbol (e.g. `MSFT.Q`).
    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<IExchangeInfo>

• getPermissionInfo

  • getPermissionInfo(timeoutMs?: number): Promise<IPermissionInfo>

    Get information about the permissioning for the user.

    Parameters

    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<IPermissionInfo>

• getRelationshipInfoList

  • getRelationshipInfoList(tableNumber?: TableNumber, timeoutMs?: number): Promise<IRelationshipInfoList>

    Get a list of relationships available from a table, or all tables.

    Parameters

    • tableNumber?: TableNumber if undefined, get all relationships that are available. Otherwise, only relationships that are available from the provided table number, *
    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<IRelationshipInfoList>

• getSubscriptionInfo

  • getSubscriptionInfo(permissionLevel: PermissionLevel, timeoutMs?: number): Promise<ISubscriptionInfo>

    Get information about what symbols are currently subscribed.

    Parameters

    • permissionLevel: PermissionLevel which permission level to retrieve the subscription info for.
    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<ISubscriptionInfo>

• getTableInfoList

  • getTableInfoList(permissionLevel: PermissionLevel, timeoutMs?: number): Promise<ITableInfoList>

    Get the list of tables available via the ContentGateway.

    Parameters

    • permissionLevel: PermissionLevel which permission level to retrieve the tables for.
    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<ITableInfoList>

• getTableSpecification

  • getTableSpecification(permissionLevel: PermissionLevel, tableNumber: TableNumber, timeoutMs?: number): Promise<ITableSpecification>

    Get the detailed specification (list of fields) for a table.

    Parameters

    • permissionLevel: PermissionLevel
    • tableNumber: TableNumber
    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<ITableSpecification>

• getUniversalFieldHelper

  • getUniversalFieldHelper(fieldId: FieldId, timeoutMs?: number): Promise<IUniversalFieldHelper> | IUniversalFieldHelper

    Get metadata about a field id.

    Parameters

    • fieldId: FieldId
    • timeoutMs?: number

    Returns Promise<IUniversalFieldHelper> | IUniversalFieldHelper

    If the metadata is already cached, a UniversalFieldHelper. Otherwise, a promise that will resolve to a UniversalFieldHelper.

• getUniversalFieldHelperList

  • getUniversalFieldHelperList(timeoutMs?: number): Promise<IUniversalFieldHelper[]>

    Get all fields that are known about across all tables.

    Parameters

    • timeoutMs?: number optional timeout in milliseconds. The returned promise will be rejected if the request doesn't complete within the provided time.

    Returns Promise<IUniversalFieldHelper[]>