NLIdentifyDeviceCriteria

Summary

Inheritance

Inherits from: NSObject

Properties

TargetDeviceId
NLWeaveIdentifierType
Specifies that only the device with the specified Weave Node ID should respond.
TargetFabricId
NLWeaveIdentifierType
Specifies that only devices that are members of the specified Weave fabric should respond.
TargetModes
NLTargetDeviceModes
Specifies that only devices that are currently in the specified modes should respond.
TargetProductId
NSInteger
Specifies that only devices with the given product code should respond.
TargetVendorId
NSInteger
Specifies that only devices manufactured by the given vendor should respond.

Public static functions

create()

Public functions

toIdentifyDeviceCriteria()

Properties

TargetDeviceId

NLWeaveIdentifierType TargetDeviceId

Specifies that only the device with the specified Weave Node ID should respond.

A value of -1 specifies all devices should respond.

NOTE: the value of the TargetDeviceId field is carried a Weave IdentifyRequest in the Destination Node ID field of the Weave message header, and thus does NOT appear in the payload of the message.

TargetFabricId

NLWeaveIdentifierType TargetFabricId

Specifies that only devices that are members of the specified Weave fabric should respond.

A value of 0 specifies that only devices that are not a member of a fabric should respond. A value of -1 specifies that all devices should respond regardless of fabric membership.

TargetModes

NLTargetDeviceModes TargetModes

Specifies that only devices that are currently in the specified modes should respond.

Values are taken from the TargetDeviceModes enum.

TargetProductId

NSInteger TargetProductId

Specifies that only devices with the given product code should respond.

A value of -1 specifies any product. If the TargetProductId field is specified, then the TargetVendorId must also be specified.

TargetVendorId

NSInteger TargetVendorId

Specifies that only devices manufactured by the given vendor should respond.

A value of -1 specifies any vendor.

Public static functions

create

virtual NLIdentifyDeviceCriteria * create()

Public functions

toIdentifyDeviceCriteria

virtual IdentifyDeviceCriteria toIdentifyDeviceCriteria()