IMetaDataRequests Metadata requests.
Methods 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.
An async iterable object. When you no longer wish to receive state changes, call `delete()` on this object.
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.
getPermissionInfo(timeoutMs?: number ): Promise <IPermissionInfo >
Get information about the permissioning for the user.
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.
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.
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.
getTableSpecification(permissionLevel: PermissionLevel , tableNumber: TableNumber , timeoutMs?: number ): Promise <ITableSpecification >
Get the detailed specification (list of fields) for a table.
Returns Promise <ITableSpecification >
Get metadata about a field id.
Parameters fieldId: FieldId
timeoutMs?: number
If the metadata is already cached, a UniversalFieldHelper. Otherwise, a promise that will resolve
to a UniversalFieldHelper.
getUniversalFieldHelperList(timeoutMs?: number ): Promise <IUniversalFieldHelper [] >
Get all fields that are known about across all tables.
Also in this Section Functions - connect Interfaces - IApiInfo - IBaseRequestParameters - ICanonicalRequestParameters - IClient - ICommonConflationParameters - IConnectParameters - IContentGatewayInfo - IContentGatewayInfoRequestHandle - IDeletable - IDynamicConflationHandler - IDynamicConflationInfo - IEnabledConflationParameters - IExchangeInfo - IFeedConflationInfo - IField - IFieldData - IFieldSet - IGetEqualParametersBase - IGetFirstLastParametersBase - IGetMatchParametersBase - IGetNextPreviousParametersBase - IGetPatternParametersBase - IHistoryBar - IHistoryRequestParameters - IImage - IIntradayBar - IIntradayRequestParametersBase - IIntradaySpecifiedMinuteRequestParameters - IIterableRecordResponse - IIterableResponse - IMetaDataRequests - INavigationalRequestParameters - INewsRequests - IPeriodBase - IPeriodCount - IPeriodDate - IPermissionInfo - IRecord - IRelationship - IRelationshipFields - IRelationshipInfo - IRequest - IRequest - IRequestHandle - IRequestHandle - IRequestHandle - IRequestHandle - IRequestParameters - IRequestParameters - IRequestParameters - ISessionConflationParameters - IStory - IStreamingRequests - ISubscriptionInfo - ISubscriptionParameters - ISymbolDirectoryRequests - ISymbolId - ISymbolResponse - ISymbolSubscriptionCount - ITableInfo - ITick - ITickRequestParameters - ITimeSeriesRequests - IUniversalFieldHelper - IUpdate - IUpdateHandler - IUpdateHandler - IWasmApiInfo - Story Classes - Date - DateTime - HighResDate - Rational - StatusCodeError - Time - TRational Enumerations - AliasMode - ConflationType - DenominatorType - DynamicConflationTrigger - EntityType - EventType - Exchange - FieldId - FieldType - FilterType - GetMatchType - HistoryFieldFilterType - HistorySeriesType - IntradayFieldFilterType - IntradayRecordFilterType - IntradaySeriesType - MatchType - PeriodType - PermissionId - PermissionLevel - RelationshipId - StatusCode - SubscriptionType - SymbolSeparator - TableNumber - TableType - TickRecordFilterType - TickType - Trend Type aliases - ConflationTypeList - CountPeriodTypes - DatePeriodTypes - FieldIdList - IConflationParameters - IGetEqualParameters - IGetFirstLastParameters - IGetMatchParameters - IGetNextPreviousParameters - IGetPatternParameters - IIntradayRequestParameters - IPeriod - IPermissionLevels - IRelationshipInfoList - IRelationships - IRequestParameters - ITableInfoList - SearchFieldIds - SymbolIdList - SymbolList - UpdateHandlerResult