Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
Public Member Functions | List of all members
PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory Interface Reference

Base interface for all paged update builders. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory:
PushTechnology.ClientInterface.Client.Topics.Update.IUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordOrderedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IPagedStringOrderedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IPagedUnorderedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordUnorderedUpdateFactory PushTechnology.ClientInterface.Client.Topics.Update.IPagedStringUnorderedUpdateFactory

Public Member Functions

IUpdate RemoveAll ()
 Create an update which removes all lines from the paged topic. More...
 

Detailed Description

Base interface for all paged update builders.

Care should be taken to only use such builders with paged topics as if used to generate updates for non paged topics the updates would fail.

Failures to perform the updates would be reported back to the session in the same way as for any other updates.

There are 4 types of paged topic and the correct update builder for the type must be used as described below.

Unordered Records

This is where the topic is a TopicType.PAGED_RECORD topic and the IPagedTopicOrderingPolicy of the topic is PagedTopicOrdering.UNORDERED. In this case an IPagedRecordUnorderedUpdateBuilder is used.

Unordered strings

This is where the topic is a TopicType.PAGED_STRING topic and the IPagedTopicOrderingPolicy of the topic is PagedTopicOrdering.UNORDERED. In this case an IPagedStringUnorderedUpdateBuilder is used.

Ordered records

This is where the topic is a TopicType.PAGED_RECORD topic and the IPagedTopicOrderingPolicy of the topic is either PagedTopicOrdering.DECLARED or PagedTopicOrdering.COMPARATOR. In this case an IPagedRecordOrderedUpdateBuilder is used.

Ordered strings

This is where the topic is a TopicType.PAGED_STRING topic and the IPagedTopicOrderingPolicy of the topic is either PagedTopicOrdering.DECLARED or PagedTopicOrdering.COMPARATOR. In this case an IPagedStringOrderedUpdateBuilder is used.

Deprecated since 5.9.

Member Function Documentation

IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory.RemoveAll ( )

Create an update which removes all lines from the paged topic.

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