Represents a subscription to a container on the Liberator.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public interface IContainerSubscription : ISubscription
Public Interface IContainerSubscription _ Implements ISubscription
public interface class IContainerSubscription : ISubscription
Members
All Members | Methods | Properties | |||
Icon | Member | Description |
---|---|---|
ChatSubscriptionListener |
Sets the chat subscription listener that will be informed of all IChatEvent events in addition
to any container level events.
passed to the ISubscriptionListener interface.
| |
ClearWindow()()() |
Removes the windowed view of the container so that updates are received for all elements in the container.
This is the initial state before SetWindow(Int32, Int32) is called.
| |
DataStatus |
Identifies if the data for the subscription truly represents the live data for the subject.
(Inherited from ISubscription.) | |
DirectorySubscriptionListener |
Sets the directory subscription listener that will be informed of all IDirectoryEvent events in addition
to any container level events.
passed to the ISubscriptionListener interface.
| |
Elements |
Gets a list of all the elements in this container.
| |
NewsSubscriptionListener |
Sets the news subscription listener that will be informed of all INewsEvent events in addition
to any container level events.
passed to the ISubscriptionListener interface.
| |
PageSubscriptionListener |
Sets the page subscription listener that will be informed of all IPageEvent events in addition
to any container level events.
passed to the ISubscriptionListener interface.
| |
Parameters |
Gets the container parameters.
Use this property in preference to the Parameters
property inherited from ISubscription.
| |
Parameters |
Gets the parameters used when subscribing to the subject on the Liberator.
(Inherited from ISubscription.) | |
PermissionSubscriptionListener |
Sets the permission subscription listener that will be informed of all IPermissionEvent events in addition
to any container level events.
passed to the ISubscriptionListener interface.
| |
RecordSubscriptionListener |
Sets the record subscription listener that will be informed of all IRecordEvent, IRecordType2Event
and IRecordType3Event events in addition to any container level events
passed to the ISubscriptionListener interface.
| |
SetWindow(Int32, Int32) |
Changes the window into the container. Call this method to receive updates for
a subset of the container elements.
| |
Status |
Gets the status of this subscription.
(Inherited from ISubscription.) | |
StorySubscriptionListener |
Sets the story subscription listener that will be informed of all IStoryEvent events in addition
to any container level events.
passed to the ISubscriptionListener interface.
| |
Subject |
The subject name to which the subscription relates (for example, "FX/EURUSD").
(Inherited from ISubscription.) | |
Subscribe()()() |
Subscribes to the Subject on the Liberator.
(Inherited from ISubscription.) | |
SubscribedToAllContainerElements |
Indicates whether or not all the elements in the container have been subscribed to.
| |
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 window.
| |
WindowStartIndex |
Gets the index of the first element in the container window.
|
Remarks
An IContainerSubscription object should be created using the CreateContainerSubscription(IContainerSubscriptionListener, String) methods of IStreamLinkProvider.
A container is made up of one or more elements of a given SubjectType (for example, Records). For more information about containers see the Caplin StreamLink Overview.