<PTDiffusionPagedRecordTopicDetailsBuilder> Protocol Reference

Introduction

The protocol to which paged record topic details builders conform.

See Also

PTDiffusionTopicDetails

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

Inheritance diagram for <PTDiffusionPagedRecordTopicDetailsBuilder>:

Properties
PTDiffusionRecordMetadata *	metadata
Properties inherited from <PTDiffusionTopicDetailsBuilder>
NSString *	reference
BOOL	tidiesOnUnsubscribe
NSDictionary< NSString *, NSString * > *	properties

Instance Methods
(void)	- orderWithOrderKeys:
(void)	- orderWithDuplicatesPolicy:orderKeys:
Instance Methods inherited from <PTDiffusionPagedTopicDetailsBuilder>
(void)	- orderWithComparatorName:
(void)	- orderWithDuplicatesPolicy:comparatorName:
(void)	- unordered
Instance Methods inherited from <PTDiffusionTopicDetailsBuilder>
(void)	- setPropertyValue:forKey:
(BOOL)	- removePropertyForKey:
(nullable NSString *)	- propertyValueForKey:

Method Documentation

- (void) orderWithDuplicatesPolicy:		(PTDiffusionPagedTopicDuplicates *)	duplicatesPolicy
orderKeys:		(NSArray< PTDiffusionPagedRecordTopicOrderKey * > *)	orderKeys

Specifies that the topic should be ordered by policy, defining the policy in terms of a list of order keys.

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 method replaces any previously declared ordering policy previously set on the builder.

Parameters

duplicatesPolicy	Specifies the duplicates policy to be applied when ordering determines that two records are equal.
orderKeys	The order keys that specify how to sort the topic data. Each key much specify a different field in the metadata in the sort priority order required. Each key must specify a different metadata field. If no keys are supplied, 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

Exceptions

NSInvalidArgumentException

If duplicatesPolicy or orderKeys are nil.

Since

5.7

- (void) orderWithOrderKeys:

(NSArray< PTDiffusionPagedRecordTopicOrderKey * > *)

orderKeys

Specifies that the topic should be ordered by policy, defining the policy in terms of a list of order keys.

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 method replaces any previously declared ordering policy previously set on the builder.

A duplicates policy of 'not allowed' is assumed.

Parameters

orderKeys

The order keys that specify how to sort the topic data. Each key much specify a different field in the metadata in the sort priority order required. Each key must specify a different metadata field. If no keys are supplied, 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.

Exceptions

NSInvalidArgumentException

If orderKeys is nil.

Since

5.7

Property Documentation

- (PTDiffusionRecordMetadata*) metadata

readwritenonatomiccopy

The record metadata defining the layout of stored record values for this topic.

Since

5.7