meet-addons-devtools/dist/services/AddonRuntimeInfo.d.ts

Set of tools helping developing addons for Meet.rs

import { IAddonTokenInfo } from "./ITokenInfo";
export interface ISettings {
    [key: string]: string;
}
export declare class AddonRuntimeInfo {
    /**
     * Gets or sets the category.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    category: string;
    /**
     * Gets or sets the localized description.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    description: string;
    /**
     *
     *
     * @type {("Canvas" | "Panel")}
     * @memberof AddonRuntimeInfo
     */
    host: "Canvas" | "Panel";
    /**
     * Material icon name (url or an AppAction)
     *
     * @type {string}
     * @memberof ManifestHosts
     */
    icon: string;
    /**
     * Material icon name to be used in dark mode (optional)
     *
     * @type {string}
     * @memberof ManifestHosts
     */
    iconDark?: string;
    /**
     * Gets or sets the addon identifier.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    identifier: string;
    /**
     * Defines the addon behavior when it becomes inactive
     * where it can become hidden (default behavior) or
     * switch to mini mode 200px width (eg. call screen).
     *
     * @type {AddonInactiveMode}
     * @memberof AddonRuntimeInfo
     */
    inactiveMode: 'hidden' | 'mini';
    /**
     * Gets or sets the value determining if addon should be preloaded on meet initialization.
     * If <c>false</c> addon will be loaded only on navigation to its workspace
     *
     * @type {boolean}
     * @memberof AddonRuntimeInfo
     */
    preloaded: boolean;
    /**
     * Gets or sets the hashed identifier of the meeting/interview aka "session"
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    sessionId: string;
    /**
     * Gets or sets the hashed identifier containing session and user identity values.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    sessionUserId: string;
    /**
     * Gets or sets the role user has in a given session.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    sessionUserRole: string;
    /**
     * Gets or sets a collection of zero or more addon runtime settings
     * which addon author defined to be passed to addon
     *
     * @type {ISettings}
     * @memberof AddonRuntimeInfo
     */
    settings: ISettings;
    /**
     * Gets or sets the hashed tenant identifier.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    tenant: string;
    /**
     * Gets or sets the localized addon title.
     *
     * @type {string}
     * @memberof AddonRuntimeInfo
     */
    title: string;
    /**
     * Gets or sets the token
     *
     * @type {ITokenInfo}
     * @memberof AddonRuntimeInfo
     */
    token: IAddonTokenInfo;
    /**
     * Gets or sets the info if the user is a guest user.
     *
     * @type {boolean}
     * @memberof AddonRuntimeInfo
     */
    isGuestUser: boolean;
}