Annoto Widget API - v3.65.0
    Preparing search index...

    Interface IAnnotoApi

    interface IAnnotoApi {
        auth(token: string): Promise<void>;
        destroy(index?: number): Promise<void>;
        getMetadata(index?: number): IMetadata;
        getWidgetState(index?: number): WidgetStateType;
        hide(index?: number): Promise<void>;
        load(config: IConfig): Promise<void>;
        logout(): Promise<void>;
        samlAuth(responseXml: string): Promise<void>;
        show(index?: number): Promise<void>;
    }
    Index

    Methods

    auth destroy getMetadata getWidgetState hide load logout samlAuth show

    Methods

    • Single Sign On (SSO) user authentication

      Parameters

      • token: string

      Returns Promise<void>

    • Destroy single or all the widgets

      Parameters

      • Optionalindex: number

        if provided destroy specific widget

      Returns Promise<void>

    • Hide single or all the widgets

      Parameters

      • Optionalindex: number

        if provided hide specific widget

      Returns Promise<void>

    • Logout current user

      Returns Promise<void>

    • Sing Sign On (SSO) user via SAML Notice: SAML integration needs to be setup for this method to work

      Parameters

      • responseXml: string

        SAMLResponse xml payload

      Returns Promise<void>

    • Show single or all the widgets

      Parameters

      • Optionalindex: number

        if provided show specific widget

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods