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

The interface for the paged string topic details builder. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IPagedStringTopicDetailsBuilder:
PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder

Public Member Functions

IPagedStringTopicDetailsBuilder Order ()
 Specifies that the topic should be ordered by policy. More...
 
IPagedStringTopicDetailsBuilder Order (PagedTopicDuplicates duplicates, PagedTopicOrder order, IPagedTopicRules rules)
 Specifies that the topic should be ordered by policy. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD >
TB Order (string comparatorName)
 Specifies PagedTopicOrdering.COMPARATOR ordering is to be applied to the topic. More...
 
TB Order (PagedTopicDuplicates duplicatesPolicy, string comparatorName)
 Specifies PagedTopicOrdering.COMPARATOR ordering is to be applied to the topic. More...
 
TB Unordered ()
 This specifies that the topic ordering should be set to PagedTopicOrdering.UNORDERED. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >
new TB SetReference (string reference)
 Sets the initial value of the topic reference. More...
 
new TB SetTidyOnUnsubscribe (bool tidy)
 Sets the 'tidy on unsubscribe' flag. More...
 
new TB SetProperty (string key, string value)
 Sets a topic property. More...
 
new TB Reset ()
 Resets the builder to its initial values. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >
new TD Build ()
 Build the content. More...
 

Detailed Description

The interface for the paged string topic details builder.

Deprecated since 5.9.

Member Function Documentation

IPagedStringTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedStringTopicDetailsBuilder.Order ( )

Specifies that the topic should be ordered by policy.

The policy would be ascending order with default collation and a duplicates policy of PagedTopicDuplicates.NOT_ALLOWED.

Calling this would replace any previously declared ordering policy.

IPagedStringTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedStringTopicDetailsBuilder.Order ( PagedTopicDuplicates  duplicates,
PagedTopicOrder  order,
IPagedTopicRules  rules 
)

Specifies that the topic should be ordered by policy.

The order and collation rules may be specified.

Calling this would replace any previously declared ordering policy set on the builder.

Parameters
duplicatesspecifies the policy to be applied when two lines are determined to be equal according to the policy. If specified as null then PagedTopicDuplicates.NOT_ALLOWED is assumed
orderspecifies the order. If this is null then ascending is assumed.
rulesspecifies collation rules to apply when sorting. If this is null then PagedTopicRules.NO_RULES is assumed.

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