CustomerListEntriesProvider class exist for short term work around while TM APIs do not have support
for passing in nativeObjects from native side of TM into JS callback. Eventually will not need JS implementation
of ICustomerListEntriesProvider since a reference to a native CustomerListEntriesProvider will be provided instead.
Each new JS CustomerListEntriesProvider has a providerId that is given from native side for TM that maps this
JS CustomerListEntriesProvider to a native CustomerListEntriesProvider.
JS CustomerListEntriesProvider uses TM to pass calls through to the associated native CustomerListEntriesProvider.
Implements
Constructors
new CustomerListEntriesProvider()
new CustomerListEntriesProvider(providerId): CustomerListEntriesProvider
Parameters
providerId
number
Returns
CustomerListEntriesProvider
Properties
providerId
providerId:number
Methods
addCustomerListChunk()
addCustomerListChunk(listType, entries): void
Adds customer managed list data to response.
Use repeated calls to addCustomerListChunk to paginate data to prevent loading large lists into memory.
Must eventually be followed by a call to commit() after all customer managed list entries have been sent.
Parameters
listType
WATCHLIST
The type of customer managed list being sent(ie. watchlist)
entries
ICustomerListEntry[]
A list of entries for the customer managed list.
Returns
void
Implementation of
ICustomerListEntriesProvider.addCustomerListChunk
commit()
commit():void
Indicates the end of responses.
Must be called after the final call of addCustomerListChunk.
Returns
void
Implementation of
ICustomerListEntriesProvider.commit
