Variable ClusterInstanceConst

ClusterInstance: MutableCluster<{
    attributes: {
        currentApp: OptionalAttribute<TypeFromFields | null, any>;
    };
    commands: {
        hideApp: Command<TypeFromFields, TypeFromFields, any>;
        launchApp: Command<TypeFromFields, TypeFromFields, any>;
        stopApp: Command<TypeFromFields, TypeFromFields, any>;
    };
    extensions: readonly [{
        component: {
            attributes: {
                catalogList: Attribute<number[], any>;
            };
        };
        flags: {
            applicationPlatform: true;
        };
    }];
    features: {
        applicationPlatform: BitFlag;
    };
    id: 1292;
    name: "ApplicationLauncher";
    revision: 1;
}, []>

Type declaration

  • Readonlyattributes: {
        currentApp: OptionalAttribute<TypeFromFields | null, any>;
    }
    • ReadonlycurrentApp: OptionalAttribute<TypeFromFields | null, any>

      This attribute shall specify the current in-focus application, identified using an Application ID, catalog vendor ID and the corresponding endpoint number when the application is represented by a Content App endpoint. A null shall be used to indicate there is no current in-focus application.

      See

      MatterSpecification.v13.Cluster § 6.4.6.2

  • Readonlycommands: {
        hideApp: Command<TypeFromFields, TypeFromFields, any>;
        launchApp: Command<TypeFromFields, TypeFromFields, any>;
        stopApp: Command<TypeFromFields, TypeFromFields, any>;
    }
    • ReadonlyhideApp: Command<TypeFromFields, TypeFromFields, any>

      Upon receipt of this command, the server shall hide the application. The application shall be either

      • the specified application, if the Application Platform feature is supported;

      • otherwise the application corresponding to the endpoint.

      The endpoint may decide to stop the application based on manufacturer specific behavior or resource constraints if any. The Status attribute shall be updated to ActiveHidden or Stopped, depending on the action taken, on the Application Basic cluster of the Endpoint corresponding to the application on which the action was taken. The Status attribute shall be updated on any other

      application whose Status may have changed as a result of this command. This command returns a Launcher Response.

      See

      MatterSpecification.v13.Cluster § 6.4.7.3

    • ReadonlylaunchApp: Command<TypeFromFields, TypeFromFields, any>

      Upon receipt of this command, the server shall launch the application with optional data. The application shall be either

      • the specified application, if the Application Platform feature is supported;

      • otherwise the application corresponding to the endpoint.

      The endpoint shall launch and bring to foreground the requisite application if the application is not already launched and in foreground. The Status attribute shall be updated to ActiveVisibleFocus on the Application Basic cluster of the Endpoint corresponding to the launched application. The Status attribute shall be updated on any other application whose Status may have changed as a result of this command. The CurrentApp attribute, if supported, shall be updated to reflect the new application in the foreground.

      This command returns a Launcher Response.

      See

      MatterSpecification.v13.Cluster § 6.4.7.1

    • ReadonlystopApp: Command<TypeFromFields, TypeFromFields, any>

      Upon receipt of this command, the server shall stop the application if it is running. The application shall be either

      • the specified application, if the Application Platform feature is supported;

      • otherwise the application corresponding to the endpoint.

      The Status attribute shall be updated to Stopped on the Application Basic cluster of the Endpoint corresponding to the stopped application. The Status attribute shall be updated on any other application whose Status may have changed as a result of this command.

      This command returns a Launcher Response.

      See

      MatterSpecification.v13.Cluster § 6.4.7.2

  • Readonlyextensions: readonly [{
        component: {
            attributes: {
                catalogList: Attribute<number[], any>;
            };
        };
        flags: {
            applicationPlatform: true;
        };
    }]

    This metadata controls which ApplicationLauncherCluster elements matter.js activates for specific feature combinations.

  • Readonlyfeatures: {
        applicationPlatform: BitFlag;
    }
    • ReadonlyapplicationPlatform: BitFlag

      ApplicationPlatform

      Support for attributes and commands required for endpoint to support launching any application within the supported application catalogs

  • Readonlyid: 1292
  • Readonlyname: "ApplicationLauncher"
  • Readonlyrevision: 1

See

Cluster

Settings

Member Visibility