Diffusion Apple API  6.3.3
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Class Methods | List of all members
PTDiffusionTopicPermission Class Reference

Introduction

Permissions protecting access-controlled operations that are evaluated for a specific topic path.

See Also
PTDiffusionGlobalPermission
Since
6.3
Inheritance diagram for PTDiffusionTopicPermission:
PTDiffusionEnumeration

Class Methods

(instancetype) + readTopic
 
(instancetype) + updateTopic
 
(instancetype) + modifyTopic
 
(instancetype) + sendToMessageHandler
 
(instancetype) + sendToSession
 
(instancetype) + selectTopic
 
(instancetype) + queryObsoleteTimeSeriesEvents
 
(instancetype) + editTimeSeriesEvents
 
(instancetype) + editOwnTimeSeriesEvents
 
(instancetype) + acquireLock
 
(instancetype) + unknownTopicPermission
 
- Class Methods inherited from PTDiffusionEnumeration
(instancetype) + NS_UNAVAILABLE
 
(NSSet< PTDiffusionEnumeration * > *) + elements
 

Additional Inherited Members

- Instance Methods inherited from PTDiffusionEnumeration
(instancetype) - NS_UNAVAILABLE
 
(BOOL) - isEqualToEnumeration:
 

Method Documentation

+ (instancetype) acquireLock

Acquire a session lock.

See Also
PTDiffusionSessionLock
Since
6.3
+ (instancetype) editOwnTimeSeriesEvents

Submit edits to time series topic events which have an author which is the same as the principal of the calling session.

This permission is a more restrictive alternative to editTimeSeriesEvents.

The updateTopic permission is required to update a time series topic. This permission is additionally required to submit edits to a time series topic where the event author is the same as the principal of the calling session.

See Also
PTDiffusionTimeSeriesFeature
+ editTimeSeriesEvents
Since
6.3
+ (instancetype) editTimeSeriesEvents

Submit edits to time series topic events.

The updateTopic permission is required to update a time series topic. This permission is additionally required to submit edits to a time series topic.

See Also
PTDiffusionTimeSeriesFeature
+ editOwnTimeSeriesEvents
Since
6.3
+ (instancetype) modifyTopic

Add a topic or remove a topic.

Since
6.3
+ (instancetype) queryObsoleteTimeSeriesEvents

Evaluate queries that return a non-current view of a time series topic.

The readTopic permission is required to evaluate any type of query for a time series topic. This permission is additionally required for queries that potentially return a non-current view of all or part of a time series. Such queries include value range queries that specify an edit range, and all types of edit range query.

See Also
PTDiffusionTimeSeriesFeature
Since
6.3
+ (instancetype) readTopic

Required to receive information from a topic.

If a session does not have read_topic permission for a topic, the topic will be excluded from the results of subscription or fetch operations for the session, and the topic's details cannot be retrieved by the session.

See Also
+ selectTopic
Since
6.3
+ (instancetype) selectTopic

Use a topic selector that selects the topic path.

A session must have this permission for the path prefix of any topic selector used to subscribe or fetch.

When the subscription or fetch request completes, the resulting topics are further filtered based on the readTopic permission.

A session that has readTopic but not selectTopic for a particular topic path cannot subscribe directly to topics belonging to the path. However, the session can be independently subscribed by a control session that has #modifySession permission in addition to the appropriate selectTopic permission.

Since
6.3
+ (instancetype) sendToMessageHandler

Send a message to a handler registered with the server.

Since
6.3
+ (instancetype) sendToSession

Send a message to a client session.

Since
6.3
+ (instancetype) unknownTopicPermission

A permission that is unsupported by the session.

Since
6.3
+ (instancetype) updateTopic

Update a topic.

Since
6.3