Class ApplicationLauncherServer

This is the default server implementation of ApplicationLauncherBehavior.

Hierarchy (view full)

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback hideApp initialize launchApp reactTo requireAttributeEnabled stopApp toString alter enable for set with

Constructors

constructor

  • new ApplicationLauncherServer(agent, backing): ApplicationLauncherServer

  • Parameters

    • agent: Agent
    • backing: BehaviorBacking

    Returns ApplicationLauncherServer

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {} & {
    currentApp$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | TypeFromFields<{
        application: FieldType<TypeFromFields<{
            applicationId: ...;
            catalogVendorId: ...;
        }>>;
        endpoint: OptionalFieldType<EndpointNumber>;
    }>, any>>;
} & {} & {
    currentApp$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | TypeFromFields<{
        application: FieldType<TypeFromFields<{
            applicationId: ...;
            catalogVendorId: ...;
        }>>;
        endpoint: OptionalFieldType<EndpointNumber>;
    }>, any>>;
} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
    applicationPlatform: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {} & {
    currentApp?: null | TypeFromFields<{
        application: FieldType<TypeFromFields<{
            applicationId: FieldType<string>;
            catalogVendorId: FieldType<number>;
        }>>;
        endpoint: OptionalFieldType<EndpointNumber>;
    }>;
} & {} & {}

Access the behavior's state.

Type declaration

  • Optional ReadonlycurrentApp?: null | TypeFromFields<{
        application: FieldType<TypeFromFields<{
            applicationId: FieldType<string>;
            catalogVendorId: FieldType<number>;
        }>>;
        endpoint: OptionalFieldType<EndpointNumber>;
    }>

    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

Static Readonlycluster

cluster: ApplicationLauncher.Cluster

Base cluster state include all attribute values but may be extended by subclasses.

Static Readonlydefaults

defaults: ClusterState.Type<ApplicationLauncher.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ApplicationLauncherInterface>>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<ApplicationLauncher.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ApplicationLauncherInterface>>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

The behavior ID for ClusterBehaviors is the name of the cluster.

Static ReadonlyInterface

Interface: ApplicationLauncherInterface

Static ReadonlyInternal

Internal: (new () => {})

Type declaration

    • new (): {}

    • Implementation of internal state. Subclasses may override to extend.

      Returns {}

    Static Readonlyname

    name: string

    Static Optional Readonlyschema

    schema?: Schema

    Static ReadonlyState

    State: (new () => ClusterState.Type<ApplicationLauncher.Cluster, Type<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior, ApplicationLauncherInterface>>)

    Static Readonlysupervisor

    supervisor: RootSupervisor

    Staticsupports

    supports: ((other: Type) => boolean)

    Type declaration

      • (other): boolean

      • Does this behavior support functionality of a specific implementation?

        Parameters

        Returns boolean

    Methods

    [asyncDispose]

    asAdmin

    • asAdmin(fn): void

    • Execute logic with elevated privileges.

      The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

      Elevated logic effectively ignores ACLs so should be used with care.

      Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.

      Parameters

      • fn: (() => void)

        the elevated logic

          • (): void

          • Returns void

      Returns void

    assertAttributeEnabled

    Protectedcallback

    • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

    • Create a generic callback function that has the same properties as a Reactor.

      Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      • A extends any[]
      • R

      Parameters

      Returns ((...args: A) => undefined | R)

        • (...args): undefined | R

        • Parameters

          • Rest...args: A

          Returns undefined | R

    hideApp

    • hideApp(request): MaybePromise<ApplicationLauncher.LauncherResponse>

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

      Parameters

      Returns MaybePromise<ApplicationLauncher.LauncherResponse>

      See

      MatterSpecification.v13.Cluster § 6.4.7.3

    initialize

    • initialize(_options?): MaybePromise

    • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

      This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

      Parameters

      • Optional_options: {}

        Returns MaybePromise

      launchApp

      • launchApp(request): MaybePromise<ApplicationLauncher.LauncherResponse>

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

        Parameters

        Returns MaybePromise<ApplicationLauncher.LauncherResponse>

        See

        MatterSpecification.v13.Cluster § 6.4.7.1

      ProtectedreactTo

      • reactTo<O>(observable, reactor, options?): void

      • Install a Reactor.

        Important: The reactor MUST be a real JS function - arrow functions will not work!

        Type Parameters

        Parameters

        Returns void

      requireAttributeEnabled

      stopApp

      • stopApp(request): MaybePromise<ApplicationLauncher.LauncherResponse>

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

        Parameters

        Returns MaybePromise<ApplicationLauncher.LauncherResponse>

        See

        MatterSpecification.v13.Cluster § 6.4.7.2

      toString

      • toString(): string

      • Description used in diagnostic messages.

        Returns string

      Staticalter

      Staticenable

      Staticfor

      Staticset

      • set<This>(this, defaults): This

      • Type Parameters

        Parameters

        Returns This

      Staticwith

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods