 |
Diffusion .NET API
5.9.24
|
|
Diffusion .NET API
5.9.24
|
Builder for paged record topic details. More...
Public Member Functions | |
| IPagedRecordTopicDetailsBuilder | Metadata (IMRecord metadata) |
| Sets record metadata to be used for the topic. More... | |
| IPagedRecordTopicDetailsBuilder | Order (params PagedRecordOrderKey[] keys) |
| Specifies that the topic should be ordered by PagedTopicOrdering.DECLARED policy, defining the policy in terms of a set or order keys. More... | |
| IPagedRecordTopicDetailsBuilder | Order (PagedTopicDuplicates duplicatesPolicy, params PagedRecordOrderKey[] keys) |
| Specifies that the topic should be ordered by PagedTopicOrdering.DECLARED policy, defining the policy in terms of a set or order keys. 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... | |
Builder for paged record topic details.
The builder can be used to set some record metadata if the default is not what is required.
Deprecated since 5.9.
| IPagedRecordTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedRecordTopicDetailsBuilder.Metadata | ( | IMRecord | metadata | ) |
Sets record metadata to be used for the topic.
If no metadata is explicitly supplied, default metadata is assumed.
If metadata is to be specified then it must be done before specifying any ordering policy as the policy will be validated against the metadata. Setting metadata will clear any previously specified ordering policy (but not any specified comparator).
| metadata | The record metadata. |
| IPagedRecordTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedRecordTopicDetailsBuilder.Order | ( | params PagedRecordOrderKey[] | keys | ) |
Specifies that the topic should be ordered by PagedTopicOrdering.DECLARED policy, defining the policy in terms of a set or order keys.
The metadata to use must be specified before specifying the order as the keys will be validated against the metadata.
Fields specified for sorting will be sorted according to their type. Strings will be sorted according to default collation rules (unless additional rules are applied in the key) and numeric types will be sorted according to the magnitude of the number.
Calling this would replace any previously declared ordering policy or string comparator previously set on the builder.
A duplicates policy of PagedTopicDuplicates.NOT_ALLOWED is assumed.
| keys | The order keys that specify how to sort the topic data. Each key must specify a different field in the metadata in the sort order priority order required. Each key must specify a different metadata field. If no keys are supplied then it is assumed that sorting will be applied to all fields in the order they occur within the record and in ascending order with default string collation. |
| IPagedRecordTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedRecordTopicDetailsBuilder.Order | ( | PagedTopicDuplicates | duplicatesPolicy, |
| params PagedRecordOrderKey[] | keys | ||
| ) |
Specifies that the topic should be ordered by PagedTopicOrdering.DECLARED policy, defining the policy in terms of a set or order keys.
The metadata to use must be specified before specifying the order as the keys will be validated against the metadata.
Fields specified for sorting will be sorted according to their type. Strings will be sorted according to default collation rules (unless additional rules are applied in the key) and numeric types will be sorted according to the magnitude of the number.
Calling this would replace any previously declared ordering policy or string comparator previously set on the builder.
A duplicates policy of PagedTopicDuplicates.NOT_ALLOWED is assumed.
| duplicatesPolicy | Specifies the duplicates policy to be applied when ordering determines that two records are equal. |
| keys | The order keys that specify how to sort the topic data. Each key must specify a different field in the metadata in the sort order priority order required. Each key must specify a different metadata field. If no keys are supplied then it is assumed that sorting will be applied to all fields in the order they occur within the record and in ascending order with default string collation. |
1.8.5 
