Console

ThreadNetworkManagementTrait 

struct ThreadNetworkManagementTrait

This trait provides an interface for managing a Thread network.

  • List of the event types that are supported by ThreadNetworkManagementTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ThreadNetworkManagementTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the ThreadNetworkManagementTrait.

    Declaration

    Swift

    let attributes: Google.ThreadNetworkManagementTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the ThreadNetworkManagementTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Google.ThreadNetworkManagementTrait, rhs: Google.ThreadNetworkManagementTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • Information about a Thread network.

    Declaration

    Swift

    struct NetworkInfo

  • Whether the device supports the activateEpskcMode command for this trait.

    Declaration

    Swift

    var supportsActivateEpskcModeCommand: Bool { get }

  • Request to activate ePSKc mode for Thread credential sharing.

    Declaration

    Swift

    func activateEpskcMode(optionalArgsProvider: ((Google.ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs) -> Void)? = nil) async throws -> Google.ThreadNetworkManagementTrait.ActivateEpskcModeCommandResponse

    Return Value

    The response from the ActivateEpskcMode command, containing the generated ephemeral key and the actual duration for which it is valid.

  • The batchable version of activateEpskcMode command above.

    See also

    activateEpskcMode

    Declaration

    Swift

    func activateEpskcModeBatchable(optionalArgsProvider: ((Google.ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Google.ThreadNetworkManagementTrait.ActivateEpskcModeCommandResponse>

  • Whether the device supports the deactivateEpskcMode command for this trait.

    Declaration

    Swift

    var supportsDeactivateEpskcModeCommand: Bool { get }

  • Request to immediately deactivate ePSKc mode.

    Declaration

    Swift

    func deactivateEpskcMode() async throws

  • The batchable version of deactivateEpskcMode command above.

    See also

    deactivateEpskcMode

    Declaration

    Swift

    func deactivateEpskcModeBatchable() throws -> BatchableCommand<Void>

  • Whether the device supports the joinNetwork command for this trait.

    Declaration

    Swift

    var supportsJoinNetworkCommand: Bool { get }

  • Request to join a Thread network using the provided operational dataset. If the border router device is already part of a network, this command will cause it to attempt to migrate to the network together with all Thread devices attached to it.

    Declaration

    Swift

    func joinNetwork(operationalDatasetTlvs: Data) async throws -> Google.ThreadNetworkManagementTrait.JoinNetworkCommandResponse

    Parameters

    operationalDatasetTlvs

    The Thread operational dataset of the network to join, in TLV format.

    Return Value

    The response from the JoinNetwork command, containing the status of the command.

  • The batchable version of joinNetwork command above.

    See also

    joinNetwork

    Declaration

    Swift

    func joinNetworkBatchable(operationalDatasetTlvs: Data) throws -> BatchableCommand<Google.ThreadNetworkManagementTrait.JoinNetworkCommandResponse>

  • Whether the device supports the leaveNetwork command for this trait.

    Declaration

    Swift

    var supportsLeaveNetworkCommand: Bool { get }

  • Request to leave the current Thread network and factory reset the Thread stack.

    Declaration

    Swift

    func leaveNetwork() async throws

  • The batchable version of leaveNetwork command above.

    See also

    leaveNetwork

    Declaration

    Swift

    func leaveNetworkBatchable() throws -> BatchableCommand<Void>