One Logo Pool Ball
MatterSupport · IOS API REFERENCE

MatterAddDeviceExtensionRequestHandler.ThreadScanResult

struct · iOS 16.1+ · SDK 27.1

struct ThreadScanResult

A result of a Thread-scan operation performed on the device Use one of these instances to create a ``MatterAddDeviceExtensionRequestHandler/ThreadNetworkAssociation`` as a possible Thread network for the device to join.

Members (17)

init · iOS 16.1+

init

TypeScript
static init(networkName: string, panID: number, extendedPANID: number, channel: number, extendedAddress: ArrayBuffer, rssi: number, version: number, linkQualityIndicator: number): MatterAddDeviceExtensionRequestHandler_ThreadScanResult
Swift declaration
init(networkName: String, panID: UInt16, extendedPANID: UInt64, channel: UInt16, extendedAddress: Data, rssi: Int8, version: UInt8, linkQualityIndicator: UInt8)

Create the extension request handler. - Parameters: - networkName: The Thread network name. - extendedPANID: The Thread network extended PAN identifier. - channel: The Thread network radio channel. - extendedAddress: The identifier of an active Thread network Border Agent. - rssi: The observed RSSI of the network by the device. - version: The version field, as specified by the Matter specification. - linkQualityIndicator: A receive quality indicator, as specified by the Matter specification.

get · iOS 16.1+

networkName

TypeScript
get networkName(): string
Swift declaration
var networkName: String

The Thread network name.

set · iOS 16.1+

networkName

TypeScript
set networkName(value: string)
Swift declaration
var networkName: String

The Thread network name.

get · iOS 16.1+

extendedPANID

TypeScript
get extendedPANID(): number
Swift declaration
var extendedPANID: UInt64

The Thread network extended PAN identifier.

set · iOS 16.1+

extendedPANID

TypeScript
set extendedPANID(value: number)
Swift declaration
var extendedPANID: UInt64

The Thread network extended PAN identifier.

get · iOS 16.1+

extendedAddress

TypeScript
get extendedAddress(): ArrayBuffer
Swift declaration
var extendedAddress: Data

The identifier of an active Thread network Border Agent. This corresponds to the Border Agent ID in <doc://com.apple.documentation/documentation/ThreadNetwork/THClient/3801785-retrievecredentials>.

set · iOS 16.1+

extendedAddress

TypeScript
set extendedAddress(value: ArrayBuffer)
Swift declaration
var extendedAddress: Data

The identifier of an active Thread network Border Agent. This corresponds to the Border Agent ID in <doc://com.apple.documentation/documentation/ThreadNetwork/THClient/3801785-retrievecredentials>.

get · iOS 16.1+

linkQualityIndicator

TypeScript
get linkQualityIndicator(): number
Swift declaration
var linkQualityIndicator: UInt8

A receive quality indicator, as specified by Matter specification.

set · iOS 16.1+

linkQualityIndicator

TypeScript
set linkQualityIndicator(value: number)
Swift declaration
var linkQualityIndicator: UInt8

A receive quality indicator, as specified by Matter specification.

get · iOS 16.1+

rssi

TypeScript
get rssi(): number
Swift declaration
var rssi: Int8

The observed RSSI of the network by the device.

set · iOS 16.1+

rssi

TypeScript
set rssi(value: number)
Swift declaration
var rssi: Int8

The observed RSSI of the network by the device.

get · iOS 16.1+

panID

TypeScript
get panID(): number
Swift declaration
var panID: UInt16

The Thread network PAN identifier.

set · iOS 16.1+

panID

TypeScript
set panID(value: number)
Swift declaration
var panID: UInt16

The Thread network PAN identifier.

get · iOS 16.1+

channel

TypeScript
get channel(): number
Swift declaration
var channel: UInt16

The Thread network radio channel.

set · iOS 16.1+

channel

TypeScript
set channel(value: number)
Swift declaration
var channel: UInt16

The Thread network radio channel.

get · iOS 16.1+

version

TypeScript
get version(): number
Swift declaration
var version: UInt8

The version field, as specified by the Matter specification.

set · iOS 16.1+

version

TypeScript
set version(value: number)
Swift declaration
var version: UInt8

The version field, as specified by the Matter specification.

Skipped declarations

No declarations were skipped in this snapshot.

All MatterSupport types →