 |
Diffusion Apple API
6.7.4
Unified Client Library for iOS, tvOS and OS X / macOS
|
|
Diffusion Apple API
6.7.4
Unified Client Library for iOS, tvOS and OS X / macOS
|
Extension adding support to the Topic Update feature for updating topics with primitive values.
| - (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:.
| path | The path of the topic. |
| value | The value. |
| specification | The required specification of the topic. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If 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). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| value | The value. |
| specification | The required specification of the topic. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If 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). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| value | The value. |
| specification | The required specification of the topic. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If 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). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| value | The value. |
| specification | The required specification of the topic. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If 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). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| value | The value. |
| specification | The required specification of the topic. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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:.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of the path, specification or completionHandler arguments are nil. Also if the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| NSInvalidArgumentException | If any argument is nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| constraint | The constraint that must be satisfied for the update stream to be validated. |
| NSInvalidArgumentException | If any argument is nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| NSInvalidArgumentException | If any argument is nil or the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| constraint | The constraint that must be satisfied for the update stream to be validated. |
| NSInvalidArgumentException | If any argument is nil or the topic type defined in the specification is incompatible with doubleFloat (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| NSInvalidArgumentException | If any argument is nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| constraint | The constraint that must be satisfied for the update stream to be validated. |
| NSInvalidArgumentException | If any argument is nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| NSInvalidArgumentException | If any argument is nil or the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| constraint | The constraint that must be satisfied for the update stream to be validated. |
| NSInvalidArgumentException | If any argument is nil or the topic type defined in the specification is incompatible with int64 (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If either path or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of path, constraint or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If either path or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If any of path, constraint or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If either path or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of path, constraint or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (void) setWithPath: | (NSString *) | path | |
| toLongLongValue: | (long long) | value | |
| completionHandler: | (NSError *_Nullable error) | completionHandler | |
Sets a topic to a specified 64-bit integer value.
| path | The path of the topic. |
| value | The value. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If either path or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| NSInvalidArgumentException | If any of path, constraint or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If either path or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| value | The value. |
| constraint | The constraint that must be satisfied for the topic to be updated. |
| completionHandler | Block 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. |
| error | If this method returns NO to indicate that an error occurred then this will be populated with the reason for that failure. |
YES on success; or NO if an error occurred, in which case *error will be populated with the failure reason.| NSInvalidArgumentException | If any of path, constraint or completionHandler are nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| NSInvalidArgumentException | If any argument is nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| constraint | The constraint that must be satisfied for the update stream to be validated. |
| NSInvalidArgumentException | If any argument is nil. |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| NSInvalidArgumentException | If any argument is nil or the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
| - (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.
| path | The path of the topic. |
| specification | The required specification of the topic. |
| constraint | The constraint that must be satisfied for the update stream to be validated. |
| NSInvalidArgumentException | If any argument is nil or the topic type defined in the specification is incompatible with string (PTDiffusionDataTypes). |
Extends class PTDiffusionTopicUpdateFeature.
1.8.5