<PTDiffusionTopicDetailsBuilder> Protocol Reference

Introduction

All topic details builders conform to this protocol.

See Also

PTDiffusionTopicDetails

Since

5.7

Inheritance diagram for <PTDiffusionTopicDetailsBuilder>:

Properties
NSString *	reference
BOOL	tidiesOnUnsubscribe
NSDictionary< NSString *, NSString * > *	properties

Instance Methods
(void)	- setPropertyValue:forKey:
(BOOL)	- removePropertyForKey:
(nullable NSString *)	- propertyValueForKey:

Method Documentation

- (nullable NSString *) propertyValueForKey:

(NSString *)

key

Gets the value of a topic property.

Parameters

key	The property key. The values for these keys and permitted valuers are published in the user documentation.

Exceptions

NSInvalidArgumentException

If key is nil.

Since

5.7

- (BOOL) removePropertyForKey:

(NSString *)

key

Removes (unsets) a topic property.

Parameters

key	The property key.

Returns

YES if the key was set and has now been unset.

Exceptions

NSInvalidArgumentException

If key is nil.

Since

5.7

- (void) setPropertyValue:		(NSString *)	value
forKey:		(NSString *)	key

Sets a topic property. This is used for setting restricted or legacy topic properties.

Parameters

value	The property value.
key	The property key. The values for these keys and permitted valuers are published in the user documentation.

Exceptions

NSInvalidArgumentException

If either value or key is nil, or the key is not supported.

Note

Properties may be removed with the removePropertyForKey: method.

Since

5.7

Property Documentation

- (NSDictionary<NSString *, NSString *>*) properties

readnonatomicassign

An immutable snapshot of the topic properties.

Since

5.7

- (NSString*) reference

readwritenonatomiccopy

The topic reference or a zero length string if not set.

Exceptions

NSInvalidArgumentException

On setting the property, if the supplied reference is nil.

Since

5.7

- (BOOL) tidiesOnUnsubscribe

readwritenonatomicassign

The 'tidy on unsubscribe' flag.

By default, if a client unsubscribes from a topic, it may still receive content already queued for it on that topic.

If this option is set to YES, when a client unsubscribes from a topic then any content for that topic that is still queued for the client is removed. There can be a performance overhead to using this option as the client queue must be locked whilst content is removed, however it may prove useful for preventing unwanted data being sent to clients.

Since

5.7