W-CF Documentation - v11.0.0
    Preparing search index...

    Interface AppCallbacks

    interface AppCallbacks {
        beginAsyncOperation?: () => void;
        endAsyncOperation?: () => void;
        showActionChoice?: (
            pActions: ChoiceAction[],
            pOptions: ShowActionChoiceOptions,
        ) => void;
        showMedia?: (pMedia: Media, pOptions: ShowMediaOptions) => void;
        showMessage?: (pMessage: Message, pOptions: ShowMessageOptions) => void;
        showPropertyEditor?: (
            pElement: SceneElement,
            pGetPropertiesCallback: () => Promise<Property[]>,
            pOptions: ShowPropertyEditorOptions,
        ) => void;
    }
    Index
    beginAsyncOperation?: () => 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.

    endAsyncOperation?: () => void

    Notifies the host application that an asynchronous operation has ended.

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

    If called the host application should show a action selection dialog. After the user selected an action the dialog has to be closed.

    Type Declaration

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

    If called the host application should show the provided media.

    Type Declaration

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

    If called the host application should show the provided message to the user.

    Type Declaration

    showPropertyEditor?: (
        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.

    Type Declaration