Console

ExtendedApplicationLauncherTrait 

struct ExtendedApplicationLauncherTrait

This trait supports devices which are able to switch between applications.

  • No supported events for ExtendedApplicationLauncherTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ExtendedApplicationLauncherTrait.

    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 ExtendedApplicationLauncherTrait.

    Declaration

    Swift

    let attributes: Google.ExtendedApplicationLauncherTrait.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 ExtendedApplicationLauncherTrait.

    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.ExtendedApplicationLauncherTrait, rhs: Google.ExtendedApplicationLauncherTrait) -> 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)

  • Application names and language-specific synonyms.

    Declaration

    Swift

    struct ApplicationNames

  • Represents an application that users of this device can interact with.

    Declaration

    Swift

    struct AvailableApplication

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

    Declaration

    Swift

    var supportsInstallAppCommand: Bool { get }

  • Install the given application.

    Declaration

    Swift

    func installApp(newApplicationName: String, newApplication: String) async throws

    Parameters

    newApplicationName

    Name of the application to install.
    newApplication

    Key of the application to install.

  • The batchable version of installApp command above.

    See also

    installApp

    Declaration

    Swift

    func installAppBatchable(newApplicationName: String, newApplication: String) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsSearchAppCommand: Bool { get }

  • Search for the given application.

    Declaration

    Swift

    func searchApp(newApplicationName: String, newApplication: String) async throws

    Parameters

    newApplicationName

    Name of the application to search for.
    newApplication

    Key of the application to search for.

  • The batchable version of searchApp command above.

    See also

    searchApp

    Declaration

    Swift

    func searchAppBatchable(newApplicationName: String, newApplication: String) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsLaunchAppCommand: Bool { get }

  • Launch the given application.

    Declaration

    Swift

    func launchApp(newApplicationName: String, newApplication: String) async throws

    Parameters

    newApplicationName

    Name of the application to launch.
    newApplication

    Key of the application to launch.

  • The batchable version of launchApp command above.

    See also

    launchApp

    Declaration

    Swift

    func launchAppBatchable(newApplicationName: String, newApplication: String) throws -> BatchableCommand<Void>

  • The type of an application.

    Declaration

    Swift

    enum ApplicationType