Studio Developer Manual / Version 2406.0
Table Of Contents
The package @coremedia/studio-client.app-context-models
provides the central utility
to access the Studio Apps context. All public API types and methods are exported via the
package's index.ts
and can consequently be imported from the package top-level.
In the following sections, many parts of this package will be covered in more detail.
The most central type of the package is StudioAppsContext
which provides a wide range of
utility methods to interact with the Studio Apps environment. It can be accessed via the global
constant studioAppsContext
:
import { studioAppsContext } from "@coremedia/studio-client.app-context-models";
It allows to access information about other apps and their offered services, to run or focus apps,
to access the initial startup parameters of the current app and several additional utilities.
The most important method is studioAppsContext._.initAppServices()
. It initializes
the whole apps context for the current app. It is recommended to call this method as early as possible
in the app's lifecycle.