Diffusion Apple API  6.3.3
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Instance Methods | List of all members
PTDiffusionTopicUpdateFeature(PTDiffusionPrimitive) Category Reference

Introduction

Extension adding support to the Topic Update feature for updating topics with primitive values.

Since
6.3

Instance Methods

(BOOL) - setWithPath:toStringValue:completionHandler:error:
 
(void) - setWithPath:toDoubleValue:completionHandler:
 
(BOOL) - setWithPath:toDoubleFloatNumberValue:completionHandler:error:
 
(void) - setWithPath:toLongLongValue:completionHandler:
 
(BOOL) - setWithPath:toInt64NumberValue:completionHandler:error:
 
(BOOL) - setWithPath:toStringValue:constraint:completionHandler:error:
 
(void) - setWithPath:toDoubleValue:constraint:completionHandler:
 
(BOOL) - setWithPath:toDoubleFloatNumberValue:constraint:completionHandler:error:
 
(void) - setWithPath:toLongLongValue:constraint:completionHandler:
 
(BOOL) - setWithPath:toInt64NumberValue:constraint:completionHandler:error:
 
(BOOL) - addWithPath:specification:andSetToStringValue:completionHandler:error:
 
(void) - addWithPath:specification:andSetToDoubleValue:completionHandler:
 
(BOOL) - addWithPath:specification:andSetToDoubleFloatNumberValue:completionHandler:error:
 
(void) - addWithPath:specification:andSetToLongLongValue:completionHandler:
 
(BOOL) - addWithPath:specification:andSetToInt64NumberValue:completionHandler:error:
 
(BOOL) - addWithPath:specification:andSetToStringValue:constraint:completionHandler:error:
 
(void) - addWithPath:specification:andSetToDoubleValue:constraint:completionHandler:
 
(BOOL) - addWithPath:specification:andSetToDoubleFloatNumberValue:constraint:completionHandler:error:
 
(void) - addWithPath:specification:andSetToLongLongValue:constraint:completionHandler:
 
(BOOL) - addWithPath:specification:andSetToInt64NumberValue:constraint:completionHandler:error:
 
(PTDiffusionStringUpdateStream *) - stringUpdateStreamWithPath:
 
(PTDiffusionNumberUpdateStream *) - doubleFloatNumberUpdateStreamWithPath:
 
(PTDiffusionNumberUpdateStream *) - int64NumberUpdateStreamWithPath:
 
(PTDiffusionStringUpdateStream *) - stringUpdateStreamWithPath:constraint:
 
(PTDiffusionNumberUpdateStream *) - doubleFloatNumberUpdateStreamWithPath:constraint:
 
(PTDiffusionNumberUpdateStream *) - int64NumberUpdateStreamWithPath:constraint:
 
(PTDiffusionStringUpdateStream *) - stringUpdateStreamWithPath:specification:
 
(PTDiffusionNumberUpdateStream *) - doubleFloatNumberUpdateStreamWithPath:specification:
 
(PTDiffusionNumberUpdateStream *) - int64NumberUpdateStreamWithPath:specification:
 
(PTDiffusionStringUpdateStream *) - stringUpdateStreamWithPath:specification:constraint:
 
(PTDiffusionNumberUpdateStream *) - doubleFloatNumberUpdateStreamWithPath:specification:constraint:
 
(PTDiffusionNumberUpdateStream *) - int64NumberUpdateStreamWithPath:specification:constraint:
 

Method Documentation

- (BOOL) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToDoubleFloatNumberValue: (nullable NSNumber *)  value
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Ensures a topic exists and sets it to a double-precision floating point (Eight-byte IEEE 754) number value, or null.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:completionHandler:.

Parameters
pathThe path of the topic.
valueThe value.
specificationThe required specification of the topic.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes).
Since
6.3
- (BOOL) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToDoubleFloatNumberValue: (nullable NSNumber *)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Ensures a topic exists and sets it to a double-precision floating point (Eight-byte IEEE 754) number value, or null, if a constraint is satisfied.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:constraint:completionHandler:.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification, constraint or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes).
Since
6.3
- (void) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToDoubleValue: (double)  value
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Ensures a topic exists and sets it to a double-precision floating point (Eight-byte IEEE 754) value.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:completionHandler:.

Parameters
pathThe path of the topic.
valueThe value.
specificationThe required specification of the topic.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes).
Since
6.3
- (void) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToDoubleValue: (double)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Ensures a topic exists and sets it to a double-precision floating point (Eight-byte IEEE 754) value if a constraint is satisfied.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:constraint:completionHandler:.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification, constraint or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes).
Since
6.3
- (BOOL) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToInt64NumberValue: (nullable NSNumber *)  value
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Ensures a topic exists and sets it to a 64-bit integer number value, or null.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:completionHandler:.

Parameters
pathThe path of the topic.
valueThe value.
specificationThe required specification of the topic.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes).
Since
6.3
- (BOOL) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToInt64NumberValue: (nullable NSNumber *)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Ensures a topic exists and sets it to a 64-bit integer number value, or null, if a constraint is satisfied.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:constraint:completionHandler:.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification, constraint or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes).
Since
6.3
- (void) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToLongLongValue: (long long)  value
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Ensures a topic exists and sets it to a 64-bit integer value.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:completionHandler:.

Parameters
pathThe path of the topic.
valueThe value.
specificationThe required specification of the topic.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes).
Since
6.3
- (void) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToLongLongValue: (long long)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler 

Ensures a topic exists and sets it to a 64-bit integer value if a constraint is satisfied.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:constraint:completionHandler:.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification, constraint or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes).
Since
6.3
- (BOOL) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToStringValue: (nullable NSString *)  value
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Ensures a topic exists and sets it to a string value, or null.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:completionHandler:.

Parameters
pathThe path of the topic.
valueThe value.
specificationThe required specification of the topic.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes).
Since
6.3
- (BOOL) addWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
andSetToStringValue: (nullable NSString *)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (PTDiffusionTopicCreationResult *_Nullable)  result
(NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Ensures a topic exists and sets it to a string value, or null, if a constraint is satisfied.

If a topic does not exist at the path, one will be created using the specification. If a topic does exist, its specification must match specification, otherwise the operation will fail.

In other respects this method works in the same way as setWithPath:toJSONValue:constraint:completionHandler:.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil and result will be non-nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes).
Since
6.3
- (PTDiffusionNumberUpdateStream *) doubleFloatNumberUpdateStreamWithPath: (NSString *)  path

Creates an update stream to use for updating a specific topic with double-precision floating point (Eight-byte IEEE 754) values.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil.
Since
6.3
- (PTDiffusionNumberUpdateStream *) doubleFloatNumberUpdateStreamWithPath: (NSString *)  path
constraint: (PTDiffusionUpdateConstraint *)  constraint 

Creates an update stream to use for updating a specific topic with double-precision floating point (Eight-byte IEEE 754) values if a constraint is satisfied.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
constraintThe constraint that must be satisfied for the update stream to be validated.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil.
Since
6.3
- (PTDiffusionNumberUpdateStream *) doubleFloatNumberUpdateStreamWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification 

Creates an update stream to use for creating and updating a specific topic with double-precision floating point (Eight-byte IEEE 754) values.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil or the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes).
Since
6.3
- (PTDiffusionNumberUpdateStream *) doubleFloatNumberUpdateStreamWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
constraint: (PTDiffusionUpdateConstraint *)  constraint 

Creates an update stream to use for creating and updating a specific topic with double-precision floating point (Eight-byte IEEE 754) values if a constraint is satisfied.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
constraintThe constraint that must be satisfied for the update stream to be validated.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil or the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes).
Since
6.3
- (PTDiffusionNumberUpdateStream *) int64NumberUpdateStreamWithPath: (NSString *)  path

Creates an update stream to use for updating a specific topic with 64-bit integer values.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil.
Since
6.3
- (PTDiffusionNumberUpdateStream *) int64NumberUpdateStreamWithPath: (NSString *)  path
constraint: (PTDiffusionUpdateConstraint *)  constraint 

Creates an update stream to use for updating a specific topic with 64-bit integer values if a constraint is satisfied.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
constraintThe constraint that must be satisfied for the update stream to be validated.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil.
Since
6.3
- (PTDiffusionNumberUpdateStream *) int64NumberUpdateStreamWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification 

Creates an update stream to use for creating and updating a specific topic with 64-bit integer values.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil or the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes).
Since
6.3
- (PTDiffusionNumberUpdateStream *) int64NumberUpdateStreamWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
constraint: (PTDiffusionUpdateConstraint *)  constraint 

Creates an update stream to use for creating and updating a specific topic with 64-bit integer values if a constraint is satisfied.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
constraintThe constraint that must be satisfied for the update stream to be validated.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil or the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes).
Since
6.3
- (BOOL) setWithPath: (NSString *)  path
toDoubleFloatNumberValue: (nullable NSNumber *)  value
completionHandler: (NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Sets a topic to a specified double-precision floating point (Eight-byte IEEE 754) number value, or null.

Parameters
pathThe path of the topic.
valueThe value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf either path or completionHandler are nil.
Since
6.3
- (BOOL) setWithPath: (NSString *)  path
toDoubleFloatNumberValue: (nullable NSNumber *)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Sets a topic to a specified double-precision floating point (Eight-byte IEEE 754) number value, or null, if a constraint is satisfied.

Parameters
pathThe path of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of path, constraint or completionHandler are nil.
Since
6.3
- (void) setWithPath: (NSString *)  path
toDoubleValue: (double)  value
completionHandler: (NSError *_Nullable error)  completionHandler 

Sets a topic to a specified double-precision floating point (Eight-byte IEEE 754) value.

Parameters
pathThe path of the topic.
valueThe value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf either path or completionHandler are nil.
Since
6.3
- (void) setWithPath: (NSString *)  path
toDoubleValue: (double)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (NSError *_Nullable error)  completionHandler 

Sets a topic to a specified double-precision floating point (Eight-byte IEEE 754) value if a constraint is satisfied.

Parameters
pathThe path of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf any of path, constraint or completionHandler are nil.
Since
6.3
- (BOOL) setWithPath: (NSString *)  path
toInt64NumberValue: (nullable NSNumber *)  value
completionHandler: (NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Sets a topic to a specified 64-bit integer number value, or null.

Parameters
pathThe path of the topic.
valueThe value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf either path or completionHandler are nil.
Since
6.3
- (BOOL) setWithPath: (NSString *)  path
toInt64NumberValue: (nullable NSNumber *)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Sets a topic to a specified 64-bit integer number value, or null, if a constraint is satisfied.

Parameters
pathThe path of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of path, constraint or completionHandler are nil.
Since
6.3
- (void) setWithPath: (NSString *)  path
toLongLongValue: (long long)  value
completionHandler: (NSError *_Nullable error)  completionHandler 

Sets a topic to a specified 64-bit integer value.

Parameters
pathThe path of the topic.
valueThe value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf either path or completionHandler are nil.
Since
6.3
- (void) setWithPath: (NSString *)  path
toLongLongValue: (long long)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (NSError *_Nullable error)  completionHandler 

Sets a topic to a specified 64-bit integer value if a constraint is satisfied.

Parameters
pathThe path of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
Exceptions
NSInvalidArgumentExceptionIf any of path, constraint or completionHandler are nil.
Since
6.3
- (BOOL) setWithPath: (NSString *)  path
toStringValue: (nullable NSString *)  value
completionHandler: (NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Sets a topic to a specified string value, or null.

Parameters
pathThe path of the topic.
valueThe value.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf either path or completionHandler are nil.
Since
6.3
- (BOOL) setWithPath: (NSString *)  path
toStringValue: (nullable NSString *)  value
constraint: (PTDiffusionUpdateConstraint *)  constraint
completionHandler: (NSError *_Nullable error)  completionHandler
error: (NSError **)  error 

Sets a topic to a specified string value, or null, if a constraint is satisfied.

Parameters
pathThe path of the topic.
valueThe value.
constraintThe constraint that must be satisfied for the topic to be updated.
completionHandlerBlock to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.
errorIf this method returns NO to indicate that an error occured then this will be populated with the reason for that failure.
Returns
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.
Exceptions
NSInvalidArgumentExceptionIf any of path, constraint or completionHandler are nil.
Since
6.3
- (PTDiffusionStringUpdateStream *) stringUpdateStreamWithPath: (NSString *)  path

Creates an update stream to use for updating a specific topic with string values.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil.
Since
6.3
- (PTDiffusionStringUpdateStream *) stringUpdateStreamWithPath: (NSString *)  path
constraint: (PTDiffusionUpdateConstraint *)  constraint 

Creates an update stream to use for updating a specific topic with string values if a constraint is satisfied.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
constraintThe constraint that must be satisfied for the update stream to be validated.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil.
Since
6.3
- (PTDiffusionStringUpdateStream *) stringUpdateStreamWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification 

Creates an update stream to use for creating and updating a specific topic with string values.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil or the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes).
Since
6.3
- (PTDiffusionStringUpdateStream *) stringUpdateStreamWithPath: (NSString *)  path
specification: (PTDiffusionTopicSpecification *)  specification
constraint: (PTDiffusionUpdateConstraint *)  constraint 

Creates an update stream to use for creating and updating a specific topic with string values if a constraint is satisfied.

Update streams send a sequence of updates for a specific topic. The updates may be delivered to the server as binary deltas. They do not provide exclusive access to the topic. If exclusive access is required update streams should be used with session locks as constraints.

Streams are validated lazily when the first 'set' or 'validate' operation is completed. Once validated a stream can be invalidated, after which it rejects future updates.

Parameters
pathThe path of the topic.
specificationThe required specification of the topic.
constraintThe constraint that must be satisfied for the update stream to be validated.
Returns
An update stream.
Exceptions
NSInvalidArgumentExceptionIf any argument is nil or the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes).
Since
6.3