IWatchListApi
Integration guide · Reference index
Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.
defaultList
defaultList(): string[];Use the type signature above and the integration guide for the owning capability.
getList
getList(id?: string): string[] | null;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
id | string | No |
getAllLists
getAllLists(): WatchListSymbolListMap | null;Use the type signature above and the integration guide for the owning capability.
setActiveList
setActiveList(id: string): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
id | string | Yes |
getActiveListId
getActiveListId(): string | null;Use the type signature above and the integration guide for the owning capability.
setList
setList(symbols: string[]): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
symbols | string[] | Yes |
updateList
updateList(listId: string, symbols: string[]): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
listId | string | Yes |
symbols | string[] | Yes |
renameList
renameList(listId: string, newName: string): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
listId | string | Yes |
newName | string | Yes |
createList
createList(listName?: string, symbols?: string[]): WatchListSymbolList | null;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
listName | string | No |
symbols | string[] | No |
saveList
saveList(list: WatchListSymbolList): boolean;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
list | WatchListSymbolList | Yes |
deleteList
deleteList(listId: string): void;Use the type signature above and the integration guide for the owning capability.
| Parameter | Type | Required |
|---|---|---|
listId | string | Yes |
onListChanged
onListChanged(): ISubscription<WatchListSymbolListChangedCallback>;Use the type signature above and the integration guide for the owning capability.
onActiveListChanged
onActiveListChanged(): ISubscription<EmptyCallback>;Use the type signature above and the integration guide for the owning capability.
onListAdded
onListAdded(): ISubscription<WatchListSymbolListAddedCallback>;Use the type signature above and the integration guide for the owning capability.
onListRemoved
onListRemoved(): ISubscription<WatchListSymbolListRemovedCallback>;Use the type signature above and the integration guide for the owning capability.
onListRenamed
onListRenamed(): ISubscription<WatchListSymbolListRenamedCallback>;Use the type signature above and the integration guide for the owning capability.