[This is preliminary documentation and is subject to change.]
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: 188.8.131.52 (184.108.40.206)
protected abstract IList<SubscriptionInformation> ReadData( int dataIndex )
Protected MustOverride Function ReadData ( dataIndex As Integer ) As IList(Of SubscriptionInformation)
- Type: SystemInt32
When data to read is paged this is the index if the data page to read. This first data page is zero and the event handler increments this value for each subsequent calls.
Return ValueType: IListSubscriptionInformation
A IListT of SubscriptionInformation that gets loaded with the subscribers found.
The event handler calls this method when it reads subscribers to send a message to. This method gets called until the returned collection is either null or empty.
Normally you read the subscribers from the built in Content Studio Subscriber repository. However it is fully possible to get the list of subscribers from any repository that is avaliable to the event handler. This includes the Active Directory, a regular database or even a file on disc.
When you implement this method you must make sure to return null or an empty collection when there is no more data to return. Even if there is only one record returned the event handler will call this method again with the dataIndex value incremented by one!