NLGenericTraitUpdatableDataSink

Summary

Inheritance

Inherits from: NSObject

Properties

name
NSString *
owner
id
resultCallbackQueue
dispatch_queue_t

Public functions

NS_UNAVAILABLE()
virtual instancetype
Disable default initializer inherited from NSObject.
clear()
virtual void
clear trait data
getBoolean:path:(BOOL *val, NSString *path)
virtual WEAVE_ERROR
Get the boolean value assigned to the property at the given path within this trait.
getBytes:(NSString *path)
virtual NSData *
Get the bytes value assigned to the property at the given path within this trait.
getDouble:path:(double *val, NSString *path)
virtual WEAVE_ERROR
Get the double value assigned to the property at the given path within this trait.
getSigned:path:(int64_t *val, NSString *path)
virtual WEAVE_ERROR
Get the int64_t value assigned to the property at the given path within this trait.
getString:(NSString *path)
virtual NSString *
Get the string value assigned to the property at the given path within this trait.
getStringArray:(NSString *path)
virtual NSArray *
Get the string array value assigned to the property at the given path within this trait.
getUnsigned:path:(uint64_t *val, NSString *path)
virtual WEAVE_ERROR
Get the uint64_t value assigned to the property at the given path within this trait.
getVersion:(uint64_t *val)
virtual WEAVE_ERROR
Returns the version of the trait represented by this data sink.
isNull:path:(BOOL *val, NSString *path)
virtual WEAVE_ERROR
Check if null property at the given path within this trait.
refreshData:failure:(GenericTraitUpdatableDataSinkCompletionBlock completionHandler, GenericTraitUpdatableDataSinkFailureBlock failureHandler)
virtual void
Begins a sync of the trait data.
setBoolean:path:(BOOL val, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path as a signed integer value with unconditional capability.
setBoolean:path:conditional:(BOOL val, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path.
setBytes:path:(NSData *val, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path with unconditional capability.
setBytes:path:conditional:(NSData *val, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path.
setDouble:path:(double val, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path as a signed integer value with unconditional capability.
setDouble:path:conditional:(double val, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path.
setNull:(NSString *path)
virtual WEAVE_ERROR
Assigns Null to the given path with unconditional capability.
setNull:conditional:(NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns Null to the given path.
setSigned:path:(int64_t val, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path as a signed integer value with unconditional capability.
setSigned:path:conditional:(int64_t val, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path as a signed integer value.
setString:path:(NSString *val, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path as a signed integer value with unconditional capability.
setString:path:conditional:(NSString *val, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path.
setStringArray:path:(NSArray *stringArray, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path with unconditional capability.
setStringArray:path:conditional:(NSArray *stringArray, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path.
setUnsigned:path:(uint64_t val, NSString *path)
virtual WEAVE_ERROR
Assigns the provided value to the given path as a signed integer value with unconditional capability.
setUnsigned:path:conditional:(uint64_t val, NSString *path, BOOL isConditional)
virtual WEAVE_ERROR
Assigns the provided value to the given path as an unsigned integer value.
toErrorString:(WEAVE_ERROR err)
virtual NSString *
convert Weave error to string

Properties

name

NSString * name

owner

id owner

resultCallbackQueue

dispatch_queue_t resultCallbackQueue

Public functions

NS_UNAVAILABLE

virtual instancetype NS_UNAVAILABLE()

Disable default initializer inherited from NSObject.

clear

virtual void clear()

clear trait data

getBoolean:path:

virtual WEAVE_ERROR getBoolean:path:(
  BOOL *val,
  NSString *path
)

Get the boolean value assigned to the property at the given path within this trait.

getBytes:

virtual NSData * getBytes:(
  NSString *path
)

Get the bytes value assigned to the property at the given path within this trait.

getDouble:path:

virtual WEAVE_ERROR getDouble:path:(
  double *val,
  NSString *path
)

Get the double value assigned to the property at the given path within this trait.

getSigned:path:

virtual WEAVE_ERROR getSigned:path:(
  int64_t *val,
  NSString *path
)

Get the int64_t value assigned to the property at the given path within this trait.

getString:

virtual NSString * getString:(
  NSString *path
)

Get the string value assigned to the property at the given path within this trait.

getStringArray:

virtual NSArray * getStringArray:(
  NSString *path
)

Get the string array value assigned to the property at the given path within this trait.

getUnsigned:path:

virtual WEAVE_ERROR getUnsigned:path:(
  uint64_t *val,
  NSString *path
)

Get the uint64_t value assigned to the property at the given path within this trait.

getVersion:

virtual WEAVE_ERROR getVersion:(
  uint64_t *val
)

Returns the version of the trait represented by this data sink.

isNull:path:

virtual WEAVE_ERROR isNull:path:(
  BOOL *val,
  NSString *path
)

Check if null property at the given path within this trait.

refreshData:failure:

virtual void refreshData:failure:(
  GenericTraitUpdatableDataSinkCompletionBlock completionHandler,
  GenericTraitUpdatableDataSinkFailureBlock failureHandler
)

Begins a sync of the trait data.

The result of this operation can be observed through the CompletionHandler and failureHandler

setBoolean:path:

virtual WEAVE_ERROR setBoolean:path:(
  BOOL val,
  NSString *path
)

Assigns the provided value to the given path as a signed integer value with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the boolean value to assign to the property

setBoolean:path:conditional:

virtual WEAVE_ERROR setBoolean:path:conditional:(
  BOOL val,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path.

Details
Parameters
path
the proto path to the property to modify
val
the boolean value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setBytes:path:

virtual WEAVE_ERROR setBytes:path:(
  NSData *val,
  NSString *path
)

Assigns the provided value to the given path with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the bytes value to assign to the property

setBytes:path:conditional:

virtual WEAVE_ERROR setBytes:path:conditional:(
  NSData *val,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path.

Details
Parameters
path
the proto path to the property to modify
val
the bytes value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setDouble:path:

virtual WEAVE_ERROR setDouble:path:(
  double val,
  NSString *path
)

Assigns the provided value to the given path as a signed integer value with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the double value to assign to the property

setDouble:path:conditional:

virtual WEAVE_ERROR setDouble:path:conditional:(
  double val,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path.

Details
Parameters
path
the proto path to the property to modify
val
the double value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setNull:

virtual WEAVE_ERROR setNull:(
  NSString *path
)

Assigns Null to the given path with unconditional capability.

Details
Parameters
path
the proto path to the property to modify

setNull:conditional:

virtual WEAVE_ERROR setNull:conditional:(
  NSString *path,
  BOOL isConditional
)

Assigns Null to the given path.

Details
Parameters
path
the proto path to the property to modify
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setSigned:path:

virtual WEAVE_ERROR setSigned:path:(
  int64_t val,
  NSString *path
)

Assigns the provided value to the given path as a signed integer value with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the int64_t value to assign to the property

setSigned:path:conditional:

virtual WEAVE_ERROR setSigned:path:conditional:(
  int64_t val,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path as a signed integer value.

Details
Parameters
path
the proto path to the property to modify
val
the int64_t value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setString:path:

virtual WEAVE_ERROR setString:path:(
  NSString *val,
  NSString *path
)

Assigns the provided value to the given path as a signed integer value with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the String value to assign to the property

setString:path:conditional:

virtual WEAVE_ERROR setString:path:conditional:(
  NSString *val,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path.

Details
Parameters
path
the proto path to the property to modify
val
the string value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setStringArray:path:

virtual WEAVE_ERROR setStringArray:path:(
  NSArray *stringArray,
  NSString *path
)

Assigns the provided value to the given path with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the string array to assign to the property

setStringArray:path:conditional:

virtual WEAVE_ERROR setStringArray:path:conditional:(
  NSArray *stringArray,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path.

Details
Parameters
path
the proto path to the property to modify
val
the string array value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

setUnsigned:path:

virtual WEAVE_ERROR setUnsigned:path:(
  uint64_t val,
  NSString *path
)

Assigns the provided value to the given path as a signed integer value with unconditional capability.

Details
Parameters
path
the proto path to the property to modify
val
the uint64_t value to assign to the property

setUnsigned:path:conditional:

virtual WEAVE_ERROR setUnsigned:path:conditional:(
  uint64_t val,
  NSString *path,
  BOOL isConditional
)

Assigns the provided value to the given path as an unsigned integer value.

Details
Parameters
path
the proto path to the property to modify
val
the uint64_t value to assign to the property
isConditional
whether or not to allow overwriting any conflicting changes. If true, then if a later version of the trait has modified this property and does not equal to required version from update, this update will be dropped; otherwise, this value will overwrite the newer change

toErrorString:

virtual NSString * toErrorString:(
  WEAVE_ERROR err
)

convert Weave error to string