Hierarchy

  • AppCallbacks

Properties

beginAsyncOperation?: (() => void)

Type declaration

    • (): void
    • Notifies the host application that an asynchronous operation was started (e.g. to show a loading animation). Note: Nested calls to begin/endAsyncOperation should be supported.

      Returns void

endAsyncOperation?: (() => void)

Type declaration

    • (): void
    • Notifies the host application that an asynchronous operation has ended.

      Returns void

showActionChoice?: ((pActions: ChoiceAction[], pOptions: ShowActionChoiceOptions) => void)

Type declaration

showMedia?: ((pMedia: Media, pOptions: ShowMediaOptions) => void)

Type declaration

    • (pMedia: Media, pOptions: ShowMediaOptions): void
    • If called the host application should show the provided media.

      Parameters

      Returns void

showMessage?: ((pMessage: Message, pOptions: ShowMessageOptions) => void)

Type declaration

showPropertyEditor?: ((pElement: SceneElement, pGetPropertiesCallback: (() => Promise<Property[]>), pOptions: ShowPropertyEditorOptions) => void)

Type declaration

    • (pElement: SceneElement, pGetPropertiesCallback: (() => Promise<Property[]>), pOptions: ShowPropertyEditorOptions): void
    • If called the host application should show a property editor. If only one property is shown, the editor should be closed automatically after the user changed the value of the property.

      Parameters

      • pElement: SceneElement

        The element which will be edited.

      • pGetPropertiesCallback: (() => Promise<Property[]>)

        Callback to retrieve the properties which should be shown. Has to be called everytime a property value was changed.

      • pOptions: ShowPropertyEditorOptions

        Customization options.

      Returns void

Generated using TypeDoc