PTDiffusionTopicDetails Class Reference

Introduction

Topic details describe a topic.

Where many topics are to have the same definition, the same topic detail can (and indeed should) be used to create many topics.

Topic details are also used to provide details of existing topics to clients. In this case schema and/or attributes may not be present in the details if that level of detail was not requested.

See Also

PTDiffusionTopicsFeature

PTDiffusionTopicControlFeature

Since

5.6

Inheritance diagram for PTDiffusionTopicDetails:

Class Methods
(instancetype)	+ topicDetailsWithType:
(instancetype)	+ childListTopicDetails
(instancetype)	+ childListTopicDetailsWithBuilderBlock:
(instancetype)	+ customTopicDetailsWithBuilderBlock:
(instancetype)	+ pagedRecordTopicDetails
(instancetype)	+ pagedRecordTopicDetailsWithBuilderBlock:
(instancetype)	+ pagedStringTopicDetails
(instancetype)	+ pagedStringTopicDetailsWithBuilderBlock:
(instancetype)	+ recordTopicDetails
(instancetype)	+ recordTopicDetailsWithBuilderBlock:
(instancetype)	+ routingTopicDetails
(instancetype)	+ routingTopicDetailsWithBuilderBlock:
(instancetype)	+ singleValueTopicDetails
(instancetype)	+ singleValueTopicDetailsWithBuilderBlock:
(instancetype)	+ slaveTopicDetailsWithBuilderBlock:
(instancetype)	+ statelessTopicDetails
(instancetype)	+ statelessTopicDetailsWithBuilderBlock:
(instancetype)	+ topicNotifyTopicDetails
(instancetype)	+ topicNotifyTopicDetailsWithBuilderBlock:

Properties
PTDiffusionTopicAttributes *	attributes
PTDiffusionTopicSchema *	schema
PTDiffusionTopicType	type

Instance Methods
(BOOL)	- isEqualToTopicDetails:

Method Documentation

+ (instancetype) childListTopicDetails

Returns new topic details for a child list topic with all default settings.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) childListTopicDetailsWithBuilderBlock:

(PTDiffusionTopicDetailsBuilderBlock)

block

Returns new topic details for a child list topic configured using the given builder block which is supplied an object conforming to the PTDiffusionTopicDetailsBuilder protocol.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) customTopicDetailsWithBuilderBlock:

(PTDiffusionCustomTopicDetailsBuilderBlock)

block

Returns new topic details for a custom topic configured using the given builder block which is supplied an object conforming to the PTDiffusionCustomTopicDetailsBuilder protocol.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

- (BOOL) isEqualToTopicDetails:

(nullable PTDiffusionTopicDetails *)

topicDetails

Compares the receiver to the given topic details.

Parameters

topicDetails

The topic details object with which to compare the receiver.

Returns

YES if the topic details is equal to the receiver, otherwise NO.

Since

5.7

+ (instancetype) pagedRecordTopicDetails

Returns new topic details for a paged record topic with all default settings.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) pagedRecordTopicDetailsWithBuilderBlock:

(PTDiffusionPagedRecordTopicDetailsBuilderBlock)

block

Returns new topic details for a paged record topic configured using the given builder block which is supplied an object conforming to the PTDiffusionPagedRecordTopicDetailsBuilder protocol.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) pagedStringTopicDetails

Returns new topic details for a paged string topic with all default settings.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) pagedStringTopicDetailsWithBuilderBlock:

(PTDiffusionPagedStringTopicDetailsBuilderBlock)

block

Returns new topic details for a paged string topic configured using the given builder block which is supplied an object conforming to the PTDiffusionPagedStringTopicDetailsBuilder protocol.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) recordTopicDetails

Returns new topic details for a record topic with all default settings.

Since

5.7

+ (instancetype) recordTopicDetailsWithBuilderBlock:

(PTDiffusionRecordTopicDetailsBuilderBlock)

block

Returns new topic details for a record topic configured using the given builder block which is supplied an object conforming to the PTDiffusionRecordTopicDetailsBuilder protocol.

Since

5.7

+ (instancetype) routingTopicDetails

Returns new topic details for a routing topic with all default settings.

Since

5.7

+ (instancetype) routingTopicDetailsWithBuilderBlock:

(PTDiffusionRoutingTopicDetailsBuilderBlock)

block

Returns new topic details for a routing topic configured using the given builder block which is supplied an object conforming to the PTDiffusionRoutingTopicDetailsBuilder protocol.

Since

5.7

+ (instancetype) singleValueTopicDetails

Returns new topic details for a single value topic with all default settings.

Since

5.7

+ (instancetype) singleValueTopicDetailsWithBuilderBlock:

(PTDiffusionSingleValueTopicDetailsBuilderBlock)

block

Returns new topic details for a single value topic configured using the given builder block which is supplied an object conforming to the PTDiffusionSingleValueTopicDetailsBuilder protocol.

Since

5.7

+ (instancetype) slaveTopicDetailsWithBuilderBlock:

(PTDiffusionSlaveTopicDetailsBuilderBlock)

block

Returns new topic details for a slave topic configured using the given builder block which is supplied an object conforming to the PTDiffusionSlaveTopicDetailsBuilder protocol.

Since

5.7

+ (instancetype) statelessTopicDetails

Returns new topic details for a stateless topic with all default settings.

Since

5.7

+ (instancetype) statelessTopicDetailsWithBuilderBlock:

(PTDiffusionTopicDetailsBuilderBlock)

block

Returns new topic details for a stateless topic configured using the given builder block which is supplied an object conforming to the PTDiffusionTopicDetailsBuilder protocol.

Since

5.7

+ (instancetype) topicDetailsWithType:

(PTDiffusionTopicType)

type

Returns new topic details of the given type set with all default settings.

This provides a simpler mechanism than using a builder where all of the builder's default values are suitable and there are no mandatory properties.

Parameters

type	The topic type for which default details are to be returned.

Exceptions

PTDiffusionUnsupportedTopicDetailsBuildException	If the creation of topic details for the given type is not supported by this client library.
PTDiffusionInvalidTopicDetailsBuilderStateException	If default details can't be created for the specified type as a builder has to be used.

Since

5.7

+ (instancetype) topicNotifyTopicDetails

Returns new topic details for a topic notify topic with all default settings.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

+ (instancetype) topicNotifyTopicDetailsWithBuilderBlock:

(PTDiffusionTopicNotifyTopicDetailsBuilderBlock)

block

Returns new topic details for a topic notify topic configured using the given builder block which is supplied an object conforming to the PTDiffusionTopicNotifyTopicDetailsBuilder protocol.

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

Property Documentation

- (PTDiffusionTopicAttributes*) attributes

readnonatomicassign

Attributes associated with this topic.

Since

5.7

- (PTDiffusionTopicSchema*) schema

readnonatomicassign

Schema associated with this topic.

Since

5.7

- (PTDiffusionTopicType) type

readnonatomicassign

The type of topic.

Since

5.6