 |
Diffusion Apple API 6.11.5
Unified Client Library for iOS, tvOS and OS X / macOS
|
Loading...
Searching...
No Matches
|
Diffusion Apple API 6.11.5
Unified Client Library for iOS, tvOS and OS X / macOS
|
A constraint requiring the current value of a JSON topic to match the partially described value.
The Swift code:
let constraint = try PTDiffusionUpdateConstraint
.jsonValue()
.withStringValue(idValue, atPointer: "/id")
.without("/cancellation")
creates a constraint for a JSON object with a specific ID value and no value for a "cancellation" property.
Missing keys are matched differently to keys that are present with null values.
Additional Inherited Members | |
 Class Methods inherited from PTDiffusionUpdateConstraint | |
| (instancetype) | + lockedWithLock: |
| (instancetype) | + noValue |
| (instancetype) | + noTopic |
| (PTDiffusionPartialJSONUpdateConstraint *) | + jsonValue |
| - (nullable instancetype) withBinaryValue: | (nonnull NSData *) | value | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a specified value.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
Only the operator IS) can be used with binary values.
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionBinary).
| - (nullable instancetype) withBooleanValue: | (bool) | value | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a boolean specified value.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
If the operator is EQ, the topic value at the given pointer will be compared to the boolean value. Other operators are not permitted with a boolean value.
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withDoubleFloatNumberValue: | (nonnull NSNumber *) | number | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a double-precision floating point (Eight-byte IEEE 754) specified number.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
The value will be compared with the number value at the topic location. This will work with JSON string or number values only. JSON strings can only be compared if they contain a value that can be parsed as a number. If a string value at the location cannot be parsed as a number, the constraint will be unsatisfied.
Any of the operators (other than IS) can be used with such number comparisons.
Decimal numbers can be compared with integral numbers so 1 is equal to 1.0, "1", or "1.0".
If a null value is supplied and the operator is EQ or NE, the topic value at the given pointer will be compared to JSON null. Other operators (other than IS) are not permitted with a null value.
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withDoubleFloatNumberValue: | (NSNumber *) | number | |
| atPointer: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a double-precision floating point (Eight-byte IEEE 754) number value at a specific position in the JSON object.
| number | The value expected at the location referenced by pointer. |
| pointer | A JSON Pointer syntax reference locating the value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
| NSInvalidArgumentException | If number or pointer is `nil`. |
null at the referenced location use withNullAt:error:instead. Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withDoubleValue: | (double) | value | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a double-precision floating point (Eight-byte IEEE 754) specified number.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
The value will be compared with the number value at the topic location. This will work with JSON string or number values only. JSON strings can only be compared if they contain a value that can be parsed as a number. If a string value at the location cannot be parsed as a number, the constraint will be unsatisfied.
Any of the operators (other than IS) can be used with such number comparisons.
Decimal numbers can be compared with integral numbers so 1 is equal to 1.0, "1", or "1.0".
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withDoubleValue: | (double) | value | |
| atPointer: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a double-precision floating point (Eight-byte IEEE 754) value at a specific position in the JSON object.
| value | The value expected at the location referenced by pointer. |
| pointer | A JSON Pointer syntax reference locating the value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
| NSInvalidArgumentException | If pointer is `nil`. |
instead. Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withInt64NumberValue: | (nonnull NSNumber *) | number | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a 64-bit integer specified value.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
The value will be compared with the number value at the topic location. This will work with JSON string or number values only. JSON strings can only be compared if they contain a value that can be parsed as a number. If a string value at the location cannot be parsed as a number, the constraint will be unsatisfied.
Any of the operators (other than IS) can be used with such number comparisons.
Decimal numbers can be compared with integral numbers so 1 is equal to 1.0, "1", or "1.0".
If a null value is supplied and the operator is EQ or NE, the topic value at the given pointer will be compared to JSON null. Other operators (other than IS) are not permitted with a null value.
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withInt64NumberValue: | (NSNumber *) | number | |
| atPointer: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a 64-bit integer number value at a specific position in the JSON object.
| number | The value expected at the location referenced by pointer. |
| pointer | A JSON Pointer syntax reference locating the value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
| NSInvalidArgumentException | If number or pointer is `nil`. |
null at the referenced location use withNullAt:error:instead. Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withLongLongValue: | (long long) | value | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a 64-bit integer specified value.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
The value will be compared with the number value at the topic location. This will work with JSON string or number values only. JSON strings can only be compared if they contain a value that can be parsed as a number. If a string value at the location cannot be parsed as a number, the constraint will be unsatisfied.
Any of the operators (other than IS) can be used with such number comparisons.
Decimal numbers can be compared with integral numbers so 1 is equal to 1.0, "1", or "1.0".
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withLongLongValue: | (long long) | value | |
| atPointer: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a 64-bit integer value at a specific position in the JSON object.
| value | The value expected at the location referenced by pointer. |
| pointer | A JSON Pointer syntax reference locating the value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
| NSInvalidArgumentException | If pointer is `nil`. |
instead. Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withNullAt: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a null value at a specific position in the JSON object.
| pointer | A JSON Pointer syntax reference locating the null value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
nil if there was an error.| NSInvalidArgumentException | If pointer is `nil`. |
| - (nullable instancetype) without: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a specific position in the JSON object to be absent. This does not match positions that have null values.
| pointer | A JSON Pointer syntax reference that should have no value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
nil if there was an error.| NSInvalidArgumentException | If the pointer argument is `nil`. |
| - (nullable instancetype) withStringValue: | (nonnull NSString *) | string | |
| atPointer: | (nonnull NSString *) | pointer | |
| comparisonOperator: | (nonnull PTDiffusionUpdateConstraintOperator *) | comparisonOperator | |
| error: | (NSError *__autoreleasing *const) | error | |
Compares a location within the JSON topic value to a string specified value.
If there is no value found at the specified pointer position, the constraint will be unsatisfied.
If the operator is EQ or NE, the string representation of the topic value at the given pointer will be compared to the supplied value.
If the value at the pointer position is not a string or number the constraint will be unsatisfied. Other operators (other than IS) are not permitted with String values.
If a null value is supplied and the operator is EQ or NE, the topic value at the given pointer will be compared to JSON null. Other operators (other than IS) are not permitted with a null value.
| value | The value to be compared against the topic value. |
| pointer | A JSON Pointer) syntax reference locating the value in the JSON object. comparisonOperator The comparison operator. See PTDiffusionUpdateConstraintOperator. |
| error | Location to store a reason in case of failure. May be nil. |
nil on failure.Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
| - (nullable instancetype) withStringValue: | (NSString *) | string | |
| atPointer: | (NSString *) | pointer | |
| error: | (NSError **) | error | |
Require a string value at a specific position in the JSON object.
| string | The value expected at the location referenced by pointer. |
| pointer | A JSON Pointer syntax reference locating the value in the JSON object. |
| error | Location to store a reason in case of failure. May be nil. |
| NSInvalidArgumentException | If string or pointer is `nil`. |
null at the referenced location use withNullAt:error:instead. Provided by category PTDiffusionPartialJSONUpdateConstraint(PTDiffusionPrimitive).
1.9.8