converse.js/src/headless/types/shared/_converse.d.ts

Browser based XMPP chat client

export default _converse;
export type Storage = import("@converse/skeletor").Storage;
export type Collection = import("@converse/skeletor").Collection;
export type DiscoState = import("../plugins/disco/index").DiscoState;
export type Profile = import("../plugins/status/profile").default;
export type VCards = import("../plugins/vcard/vcard").default;
declare const _converse: ConversePrivateGlobal;
declare const ConversePrivateGlobal_base: (new (...args: any[]) => {
    on(name: string, callback: (event: any, model: import("@converse/skeletor/src/types/model.js").Model, collection: import("@converse/skeletor").Collection, options?: Record<string, any>) => any, context: any): any;
    _events: any;
    _listeners: {};
    listenTo(obj: any, name: string, callback?: (event: any, model: import("@converse/skeletor/src/types/model.js").Model, collection: import("@converse/skeletor").Collection, options?: Record<string, any>) => any): any;
    _listeningTo: {};
    _listenId: any;
    off(name: string, callback: (event: any, model: import("@converse/skeletor/src/types/model.js").Model, collection: import("@converse/skeletor").Collection, options?: Record<string, any>) => any, context?: any): any;
    stopListening(obj?: any, name?: string, callback?: (event: any, model: import("@converse/skeletor/src/types/model.js").Model, collection: import("@converse/skeletor").Collection, options?: Record<string, any>) => any): any;
    once(name: string, callback: (event: any, model: import("@converse/skeletor/src/types/model.js").Model, collection: import("@converse/skeletor").Collection, options?: Record<string, any>) => any, context: any): any;
    listenToOnce(obj: any, name: string, callback?: (event: any, model: import("@converse/skeletor/src/types/model.js").Model, collection: import("@converse/skeletor").Collection, options?: Record<string, any>) => any): any;
    trigger(name: string, ...args: any[]): any;
}) & ObjectConstructor;
/**
 * A private, closured namespace containing the private api (via {@link _converse.api})
 * as well as private methods and internal data-structures.
 * @global
 * @namespace _converse
 */
declare class ConversePrivateGlobal extends ConversePrivateGlobal_base {
    constructor();
    initialize(): void;
    VERSION_NAME: string;
    strict_plugin_dependencies: boolean;
    pluggable: any;
    templates: {};
    storage: {};
    promises: {
        initialized: Promise<any> & {
            isResolved: boolean;
            isPending: boolean;
            isRejected: boolean;
            resolve: (value: any) => void;
            reject: (reason?: any) => void;
        };
    };
    NUM_PREKEYS: number;
    TIMEOUTS: {
        PAUSED: number;
        INACTIVE: number;
    };
    api: any;
    /**
     * Namespace for storing translated strings.
     *
     * @typedef {Record<string, string>} UserMessage
     * @typedef {Record<string, string|UserMessage>} UserMessages
     */
    labels: Record<string, string | Record<string, string>>;
    /**
     * Namespace for storing code that might be useful to 3rd party
     * plugins. We want to make it possible for 3rd party plugins to have
     * access to code (e.g. classes) from converse.js without having to add
     * converse.js as a dependency.
     */
    exports: Record<string, any>;
    /**
     * Provides a way for 3rd party plugins to access constants used by
     * Converse.
     */
    constants: Record<string, any>;
    /**
     * Utility methods and globals from bundled 3rd party libraries.
     */
    env: import("./api/types.js").ConverseEnv;
    /**
     * Namespace for storing the state, as represented by instances of
     * Models and Collections.
     *
     * @typedef {Object & Record<string, Collection|Model|VCards|Profile|DiscoState>} ConverseState
     * @property {VCards} [vcards]
     * @property {Profile} profile
     * @property {DiscoState} disco
     */
    state: any;
    initSession(): void;
    session: Model;
    /**
     * Translate the given string based on the current locale.
     * @method __
     * @memberOf _converse
     * @param {...String} args
     */
    __(...args: string[]): any;
    /**
     * A no-op method which is used to signal to gettext that the passed in string
     * should be included in the pot translation file.
     *
     * In contrast to the double-underscore method, the triple underscore method
     * doesn't actually translate the strings.
     *
     * One reason for this method might be because we're using strings we cannot
     * send to the translation function because they require variable interpolation
     * and we don't yet have the variables at scan time.
     *
     * @method ___
     * @memberOf _converse
     * @param {String} str
     */
    ___(str: string): string;
}
import { Model } from '@converse/skeletor';
//# sourceMappingURL=_converse.d.ts.map