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.IPagedStringTopicDetails Interface Reference

Details of a TopicType.PAGED_STRING topic. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IPagedStringTopicDetails:
PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetails PushTechnology.ClientInterface.Client.Topics.ITopicDetails

Public Member Functions

IPagedStringTopicDetailsBuilder CreateBuilder ()
 Returns a new builder initialised with the values from these details. More...
 

Additional Inherited Members

- Properties inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetails
TopicDetailsLevel Level [get]
 Returns the level of detail available. More...
 
TopicType Type [get]
 Returns the topic type. More...
 
ITopicDetailsSchema Schema [get]
 Returns the topic schema. More...
 
ITopicDetailsAttributes Attributes [get]
 Returns the topic attributes. More...
 

Detailed Description

Details of a TopicType.PAGED_STRING topic.

This is an IPagedTopicDetails where each line of data is a string.

A paged string topic can be unordered (the default) or ordered. There are two types of ordering, PagedTopicOrdering.DECLARED where the rules for ordering are explicitly specified or PagedTopicOrdering.COMPARATOR where ordering is determined by a server-side comparator of generic type string.

The ordering may be obtained from the policy returned from IPagedTopicDetailsAttributes.OrderingPolicy.

If ordering is declared then the IPagedTopicDetailsAttributes.OrderingPolicy property can be cast to PagedStringOrderingPolicy to obtain further detail.

When defining details an ordering policy may be specified using the IPagedStringTopicDetailsBuilder.Order() method.

The easiest way to create an instance of such details is using ITopicControl.NewDetails(TopicType), for example:

var control = session.GetTopicControlFeature(); var details = control.NewDetails( TopicType.PAGED_STRING );

Alternatively the details can be created using a builder obtained as follows:

var builder = control.CreateDetailsBuilder<IPagedStringTopicDetailsBuilder>();

Deprecated since 5.9.

Member Function Documentation

IPagedStringTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedStringTopicDetails.CreateBuilder ( )

Returns a new builder initialised with the values from these details.

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