Represents a subscription to a container on the Liberator.
![](../icons/collapse_all.gif)
C# | Visual Basic | Visual C++ |
public interface IContainerSubscription : ISubscription
Public Interface IContainerSubscription _ Implements ISubscription
public interface class IContainerSubscription : ISubscription
![](../icons/collapse_all.gif)
All Members | Methods | Properties | |||
Icon | Member | Description |
---|---|---|
![]() | ClearWindow()()() |
Removes the windowed view of the container so that updates are received for all elements. This is the initial state before setWindow is called
|
![]() | DataStatus |
Identifies if the data for the subscription truely represents the live data for the subject.
(Inherited from ISubscription.) |
![]() | Elements |
Get a list of the elements in this container.
|
![]() | Parameters |
Gets the container parameters.
|
![]() | Parameters |
Gets the parameters used when subscribing to the subject on the Liberator.
(Inherited from ISubscription.) |
![]() | RecordSubscriptionListener |
Sets the record subscription listener that will be informed of all IRecordEvent, IRecordType2Event
and IRecordType3Event events in addition to any events passed to the ISubscriptionListener
interface.
|
![]() | SetWindow(Int32, Int32) |
Change the visible window into the container. Call this in order to receive updates for a subset of the contents of the container.
|
![]() | Status |
Gets the status of this subscription.
(Inherited from ISubscription.) |
![]() | Subject |
The name that the subscription will request when subscribed.
(Inherited from ISubscription.) |
![]() | Subscribe()()() |
Subscribes to the Subject on the Liberator.
(Inherited from ISubscription.) |
![]() | SubscribedToAllContainerElements |
Gets a value indicating whether all elements in the container have been subscribed to. No window has been set.
|
![]() | SubscriptionListener |
Gets the ISubscriptionListener that is informed of
all subscription events relating to this subscription.
(Inherited from ISubscription.) |
![]() | Type |
Identifies the type of subject the subscription is for.
(Inherited from ISubscription.) |
![]() | Unsubscribe()()() |
Unsubscribes to the Subject on the Liberator.
(Inherited from ISubscription.) |
![]() | WindowSize |
Gets the number of elements in the container that have been requested from the given WindowStartIndex.
|
![]() | WindowStartIndex |
Gets the index of the first container element that is being requested from the container.
|
![](../icons/collapse_all.gif)
An IContainerSubscription object should be created using the CreateContainerSubscription(IContainerSubscriptionListener, String) methods.
The Container is made up of one or more subjects (for example, Records). When a container is requested by the user (for example, /BOOK1), an instance of a IContainerSubscription will be created and subsequent updates for the elements within the container will be directed to that instance and the IContainerSubscriptionListener associated with the instance informed.