Overview of sdk-pluggable-application-model

Home > @gooddata/sdk-pluggable-application-model

sdk-pluggable-application-model package

Model contracts for pluggable application integration.

Enumerations

Enumeration	Description
PantherTier	(ALPHA) Panther tier.

Functions

Function	Description
isPlatformContextV1(context)	(ALPHA) Type guard for IPlatformContextV1.
isReloadPlatformContextRequestedEvent(obj)	(ALPHA) Type guard for IReloadPlatformContextRequestedEvent.
reloadPlatformContextRequested()	(ALPHA) Creates an IReloadPlatformContextRequestedEvent.

Interfaces

Interface	Description
IApiTokenAuthCredentials	(ALPHA) GoodData API-token authentication.
IAppHeaderOptions	(ALPHA) Header customization options that a pluggable application can push to the host shell.
IAppInstance	(ALPHA) Mounted application instance.
IContextDeferredAuthCredentials	(ALPHA) Cookie / session-based authentication — no explicit credentials required.
IHostUiModule	(ALPHA) Host UI module contract.
IHostUiMountHandle	(ALPHA) Handle returned from a host UI mount for lifecycle management.
IHostUiMountOptions	(ALPHA) Options passed by the host into a host UI module's mount function.
IJwtAuthCredentials	(ALPHA) JWT-based authentication.
INewDeploymentAvailableHostUiNotification	(ALPHA) Notification dispatched when the host runtime detects that a newer build of the host application has been deployed while the user's tab is still open.
IOrganization	(ALPHA) Organization information available in the platform context.
IOrganizationPermissions	(ALPHA) Organization-level permissions.
IPlatformContextV1	(ALPHA) Platform context contract version 1.0.
IPluggableApp	(ALPHA) Pluggable application entrypoint.
IPluggableAppEvent	(ALPHA) Event emitted by the pluggable application towards the host.
IPluggableApplicationMountHandle	(ALPHA) Handle returned from mount for lifecycle management and host -> module interaction.
IPluggableApplicationMountOptions	(ALPHA) Options passed by the host into a pluggable application's mount function.
IPluggableApplicationNavigation	(ALPHA) Navigation facade exposed to pluggable applications.
IPluggableAppTelemetryCallbacks	(ALPHA) Telemetry callbacks provided by the shell to pluggable applications.
IReloadPlatformContextRequestedEvent	(ALPHA) Event requesting the host to reload the platform context.
ITelemetryEventOptions	(ALPHA) Optional configuration for a telemetry event.

Variables

Variable	Description
DefaultApplicationId	(ALPHA) The object contains constants with IDs of default platform applications. These IDs are used to identify application in the platform registry. They are documented in public documentation and can be used by customers in their manifests to override the default application behavior (for example, to disable it, move it in the navigation menu, etc.).
PluggableAppEventType	(ALPHA) Known generic pluggable application event types.

Type Aliases

Type Alias	Description
EmbeddingMode	(ALPHA) Pluggable application embedding mode.
HostUiMount	(ALPHA) Host UI mount function signature.
IAuthCredentials	(ALPHA) Authentication credentials for building a backend instance.
IHostUiNotification	(ALPHA) Discriminated union of out-of-band notifications the host runtime can push into the host UI module after mount. Lets the runtime signal events that should affect the UI without coupling it to a specific rendering.
IPlatformContext	(ALPHA) Platform context contract.
KnownPluggableAppEventTypeName	(ALPHA) Union of known pluggable application event type names.
PluggableAppEventTypeName	(ALPHA) Event type name accepted by pluggable application to host events.
PluggableApplicationMount	(ALPHA) Pluggable application mount function signature.
TelemetryChannel	(ALPHA) Telemetry channel determines which analytics pipeline receives the event.