Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Topics.Update.IPagedStringOrderedUpdateFactory Interface Reference

Update factory for ordered TopicType.PAGED_STRING topics. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.Update.IPagedStringOrderedUpdateFactory:
PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IUpdateFactory

Public Member Functions

IUpdate Add (string line)
 Create an update that will add a line to the paged topic. More...
 
IUpdate Remove (string line)
 Add a request to remove a line of data. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory
IUpdate RemoveAll ()
 Create an update which removes all lines from the paged topic. More...
 

Detailed Description

Update factory for ordered TopicType.PAGED_STRING topics.

Instances of this factory can be obtained from the ITopicUpdateControl feature using ITopicUpdateControl.UpdateFactory{TF}, for example:

var updateControl = session.GetTopicUpdateControlFeature(); var factory = updateControl.UpdateFactory<IPagedStringOrderedUpdateFactory>();

Deprecated since 5.9.

Member Function Documentation

IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedStringOrderedUpdateFactory.Add ( string  line)

Create an update that will add a line to the paged topic.

The line will be added at the position indicated by the IPagedTopicOrderingPolicy ordering policy of the topic. Duplicates will be handled according to the PagedTopicDuplicates duplicates policy indicated for the topic.

Parameters
lineThe line to add.
Returns
The new update.
IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedStringOrderedUpdateFactory.Remove ( string  line)

Add a request to remove a line of data.

The PagedTopicOrderingPolicy ordering policy is used to locate a line that matches the specified line and that line is then removed and all interested clients are notified. If no match is found then no action occurs. If there is more than one line that matches then the line removed would depend on the PagedTopicDuplicates duplicates policy.

Parameters
lineThe line to remove.
Returns
The new update.

The documentation for this interface was generated from the following file: