Diffusion Apple API  5.9.24
Unified Client Library for iOS, OS X and tvOS
 All Classes Functions Variables Properties Pages
Properties | Instance Methods | List of all members
PTDiffusionTopicAttributes Class Reference

Introduction

Attributes applicable to all topic types.

A topic attributes object is immutable.

See Also
PTDiffusionTopicDetailsBuilder
Since
5.7
Inheritance diagram for PTDiffusionTopicAttributes:
PTDiffusionCustomTopicAttributes PTDiffusionPagedTopicAttributes PTDiffusionProtocolBufferTopicAttributes PTDiffusionRecordTopicAttributes PTDiffusionRoutingTopicAttributes PTDiffusionServiceTopicAttributes PTDiffusionSlaveTopicAttributes PTDiffusionTopicNotifyTopicAttributes

Properties

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

Instance Methods

(BOOL) - isEqualToTopicAttributes:
 

Method Documentation

- (BOOL) isEqualToTopicAttributes: (nullable PTDiffusionTopicAttributes *)  topicAttributes

Compares the receiver to the given topic attributes.

Parameters
topicAttributesThe topic attributes object with which to compare the receiver.
Returns
YES if the topic attributes is equal to the receiver, otherwise NO.
Since
5.7

Property Documentation

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

Additional properties.

Since
5.7
- (NSString*) reference
readnonatomicassign

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

Since
5.7
- (BOOL) tidiesOnUnsubscribe
readnonatomicassign

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