pCon.basket - Plugin Development
    Preparing search index...

    Interface ActivityHost

    interface ActivityHost {
        container: HTMLElement;
        eventTitleChanged: ListenableEvent<string, ActivityHost>;
        title: string;
        titleEditable: boolean;
        loadUserSettings(): Promise<void>;
        stopActivity(pCancelable: boolean): void;
    }
    Index
    container: HTMLElement

    HTML container element for the activity.

    eventTitleChanged: ListenableEvent<string, ActivityHost>

    Event which will be triggered if the user edited the title.

    title: string

    Sets/gets the current title. Setting the title does not trigger eventTitleChanged.

    titleEditable: boolean

    If true the user may edit the title. (default: false)

    • If the activity (e.g. Integration) provides a UserSettingsStorage, this function has to be called to load the settings.

      Returns Promise<void>

    • Stops and disposes the activity.

      Parameters

      • pCancelable: boolean

        If true the stop of the activity may be canceled.

      Returns void