converse.js
Version:
Browser based XMPP chat client
412 lines • 24.5 kB
TypeScript
export default ChatBox;
declare const ChatBox_base: {
new (...args: any[]): {
_vcard: import("../vcard/vcard.js").default;
lazy_load_vcard: boolean;
initialize(): void;
readonly vcard: import("../vcard/vcard.js").default;
getVCard(): Promise<import("../vcard/vcard.js").default | null>;
cid: any;
attributes: {};
validationError: string;
collection: any;
changed: {};
browserStorage: Storage;
_browserStorage: Storage;
readonly idAttribute: string;
readonly cidPrefix: string;
preinitialize(): void;
validate(attrs: object, options?: object): string;
toJSON(): any;
sync(method: "create" | "update" | "patch" | "delete" | "read", model: import("@converse/skeletor").Model, options: import("@converse/skeletor/src/types/model.js").Options): any;
get(attr: string): any;
keys(): string[];
values(): any[];
pairs(): [string, any][];
entries(): [string, any][];
invert(): any;
pick(...args: any[]): any;
omit(...args: any[]): any;
isEmpty(): any;
has(attr: string): boolean;
matches(attrs: import("@converse/skeletor/src/types/model.js").Attributes): boolean;
set(key: string | any, val?: string | any, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
_changing: boolean;
_previousAttributes: any;
id: any;
_pending: boolean | import("@converse/skeletor/src/types/model.js").Options;
unset(attr: string, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
clear(options: import("@converse/skeletor/src/types/model.js").Options): false | any;
hasChanged(attr?: string): any;
changedAttributes(diff: any): any;
previous(attr?: string): any;
previousAttributes(): any;
fetch(options?: import("@converse/skeletor/src/types/model.js").Options): any;
save(key?: string | import("@converse/skeletor/src/types/model.js").Attributes, val?: boolean | number | string | import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): any;
destroy(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
url(): any;
parse(resp: import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): import("@converse/skeletor/src/types/model.js").Options;
isNew(): boolean;
isValid(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
_validate(attrs: import("@converse/skeletor/src/types/model.js").Attributes, options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
on(name: string, callback: (event: any, model: import("@converse/skeletor").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").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").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
once(name: string, callback: (event: any, model: import("@converse/skeletor").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
trigger(name: string, ...args: any[]): any;
constructor: Function;
toString(): string;
toLocaleString(): string;
valueOf(): Object;
hasOwnProperty(v: PropertyKey): boolean;
isPrototypeOf(v: Object): boolean;
propertyIsEnumerable(v: PropertyKey): boolean;
};
} & {
new (...args: any[]): {
disable_mam: boolean;
initialize(): Promise<void>;
initNotifications(): void;
notifications: import("@converse/skeletor").Model;
initUI(): void;
ui: import("@converse/skeletor").Model;
getDisplayName(): string;
canPostMessages(): boolean;
createMessage(attrs: any, options: any): Promise<any>;
getMessagesCacheKey(): string;
getMessagesCollection(): any;
getNotificationsText(): any;
initMessages(): void;
messages: any;
fetchMessages(): any;
afterMessagesFetched(): void;
onMessage(_attrs_or_error: import("../../shared/types").MessageAttributes | Error): Promise<void>;
getUpdatedMessageAttributes(message: import("../../shared/message").default<any>, attrs: import("../../shared/types").MessageAttributes): object;
updateMessage(message: import("../../shared/message").default<any>, attrs: import("../../shared/types").MessageAttributes): void;
handleCorrection(attrs: import("../../shared/types").MessageAttributes | import("../muc/types.js").MUCMessageAttributes): Promise<import("../../shared/message").default<any> | void>;
queueMessage(attrs: import("../../shared/types").MessageAttributes): any;
msg_chain: any;
getOutgoingMessageAttributes(_attrs?: import("../../shared/types").MessageAttributes): Promise<import("../../shared/types").MessageAttributes>;
sendMessage(attrs?: any): Promise<import("../../shared/message").default<any>>;
retractOwnMessage(message: import("../../shared/message").default<any>): void;
sendFiles(files: File[]): Promise<void>;
setEditable(attrs: any, send_time: string): void;
setChatState(state: string, options?: object): any;
chat_state_timeout: NodeJS.Timeout;
onMessageAdded(message: import("../../shared/message").default<any>): void;
onMessageUploadChanged(message: import("../../shared/message").default<any>): Promise<void>;
onMessageCorrecting(message: import("../../shared/message").default<any>): void;
onScrolledChanged(): void;
pruneHistoryWhenScrolledDown(): void;
shouldShowErrorMessage(attrs: import("../../shared/types").MessageAttributes): Promise<boolean>;
clearMessages(): Promise<void>;
editEarlierMessage(): void;
editLaterMessage(): any;
isChatMessage(_message: import("../../shared/message").default<any>): boolean;
getOldestMessage(): import("../../shared/message").default<any>;
getMostRecentMessage(): import("../../shared/message").default<any>;
getMessageReferencedByError(attrs: object): any;
findDanglingRetraction(attrs: object): import("../../shared/message").default<any> | null;
getDuplicateMessage(attrs: object): import("../../shared/message").default<any>;
getOriginIdQueryAttrs(attrs: object): {
origin_id: any;
from: any;
};
getStanzaIdQueryAttrs(attrs: object): {}[];
getMessageBodyQueryAttrs(attrs: object): {
from: any;
msgid: any;
};
sendMarkerForMessage(msg: import("../../shared/message").default<any>, type?: ("received" | "displayed" | "acknowledged"), force?: boolean): Promise<void>;
handleUnreadMessage(message: import("../../shared/message").default<any>): void;
getErrorAttributesForMessage(message: import("../../shared/message").default<any>, attrs: import("../../shared/types").MessageAttributes): Promise<any>;
handleErrorMessageStanza(stanza: Element): Promise<void>;
incrementUnreadMsgsCounter(message: import("../../shared/message").default<any>): void;
clearUnreadMsgCounter(): void;
handleRetraction(attrs: import("../../shared/types").MessageAttributes): Promise<boolean>;
handleReceipt(attrs: import("../../shared/types").MessageAttributes): boolean;
createMessageStanza(message: import("../../shared/message").default<any>): Promise<any>;
pruneHistory(): void;
debouncedPruneHistory: import("lodash").DebouncedFunc<() => void>;
isScrolledUp(): any;
isHidden(): boolean;
cid: any;
attributes: {};
validationError: string;
collection: any;
changed: {};
browserStorage: Storage;
_browserStorage: Storage;
readonly idAttribute: string;
readonly cidPrefix: string;
preinitialize(): void;
validate(attrs: object, options?: object): string;
toJSON(): any;
sync(method: "create" | "update" | "patch" | "delete" | "read", model: import("@converse/skeletor").Model, options: import("@converse/skeletor/src/types/model.js").Options): any;
get(attr: string): any;
keys(): string[];
values(): any[];
pairs(): [string, any][];
entries(): [string, any][];
invert(): any;
pick(...args: any[]): any;
omit(...args: any[]): any;
isEmpty(): any;
has(attr: string): boolean;
matches(attrs: import("@converse/skeletor/src/types/model.js").Attributes): boolean;
set(key: string | any, val?: string | any, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
_changing: boolean;
_previousAttributes: any;
id: any;
_pending: boolean | import("@converse/skeletor/src/types/model.js").Options;
unset(attr: string, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
clear(options: import("@converse/skeletor/src/types/model.js").Options): false | any;
hasChanged(attr?: string): any;
changedAttributes(diff: any): any;
previous(attr?: string): any;
previousAttributes(): any;
fetch(options?: import("@converse/skeletor/src/types/model.js").Options): any;
save(key?: string | import("@converse/skeletor/src/types/model.js").Attributes, val?: boolean | number | string | import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): any;
destroy(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
url(): any;
parse(resp: import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): import("@converse/skeletor/src/types/model.js").Options;
isNew(): boolean;
isValid(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
_validate(attrs: import("@converse/skeletor/src/types/model.js").Attributes, options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
on(name: string, callback: (event: any, model: import("@converse/skeletor").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").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").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
once(name: string, callback: (event: any, model: import("@converse/skeletor").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
trigger(name: string, ...args: any[]): any;
constructor: Function;
toString(): string;
toLocaleString(): string;
valueOf(): Object;
hasOwnProperty(v: PropertyKey): boolean;
isPrototypeOf(v: Object): boolean;
propertyIsEnumerable(v: PropertyKey): boolean;
};
} & {
new (...args: any[]): {
initialize(): void;
rosterContactAdded: Promise<any> & {
isResolved: boolean;
isPending: boolean;
isRejected: boolean;
resolve: (value: any) => void;
reject: (reason?: any) => void;
};
contact: import("../roster/contact.js").default | import("../status/profile.js").default;
setModelContact(jid: string): Promise<void>;
cid: any;
attributes: {};
validationError: string;
collection: any;
changed: {};
browserStorage: Storage;
_browserStorage: Storage;
readonly idAttribute: string;
readonly cidPrefix: string;
preinitialize(): void;
validate(attrs: object, options?: object): string;
toJSON(): any;
sync(method: "create" | "update" | "patch" | "delete" | "read", model: import("@converse/skeletor").Model, options: import("@converse/skeletor/src/types/model.js").Options): any;
get(attr: string): any;
keys(): string[];
values(): any[];
pairs(): [string, any][];
entries(): [string, any][];
invert(): any;
pick(...args: any[]): any;
omit(...args: any[]): any;
isEmpty(): any;
has(attr: string): boolean;
matches(attrs: import("@converse/skeletor/src/types/model.js").Attributes): boolean;
set(key: string | any, val?: string | any, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
_changing: boolean;
_previousAttributes: any;
id: any;
_pending: boolean | import("@converse/skeletor/src/types/model.js").Options;
unset(attr: string, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
clear(options: import("@converse/skeletor/src/types/model.js").Options): false | any;
hasChanged(attr?: string): any;
changedAttributes(diff: any): any;
previous(attr?: string): any;
previousAttributes(): any;
fetch(options?: import("@converse/skeletor/src/types/model.js").Options): any;
save(key?: string | import("@converse/skeletor/src/types/model.js").Attributes, val?: boolean | number | string | import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): any;
destroy(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
url(): any;
parse(resp: import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): import("@converse/skeletor/src/types/model.js").Options;
isNew(): boolean;
isValid(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
_validate(attrs: import("@converse/skeletor/src/types/model.js").Attributes, options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
on(name: string, callback: (event: any, model: import("@converse/skeletor").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").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").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
once(name: string, callback: (event: any, model: import("@converse/skeletor").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
trigger(name: string, ...args: any[]): any;
constructor: Function;
toString(): string;
toLocaleString(): string;
valueOf(): Object;
hasOwnProperty(v: PropertyKey): boolean;
isPrototypeOf(v: Object): boolean;
propertyIsEnumerable(v: PropertyKey): boolean;
};
} & {
new (...args: any[]): {
setColor(): Promise<void>;
getIdentifier(): any;
getColor(): Promise<string>;
getAvatarStyle(append_style?: string): Promise<string>;
cid: any;
attributes: {};
validationError: string;
collection: any;
changed: {};
browserStorage: Storage;
_browserStorage: Storage;
readonly idAttribute: string;
readonly cidPrefix: string;
preinitialize(): void;
initialize(attrs?: import("@converse/skeletor/src/types/model.js").Attributes, options?: import("@converse/skeletor/src/types/model.js").ModelOptions): void;
validate(attrs: object, options?: object): string;
toJSON(): any;
sync(method: "create" | "update" | "patch" | "delete" | "read", model: import("@converse/skeletor").Model, options: import("@converse/skeletor/src/types/model.js").Options): any;
get(attr: string): any;
keys(): string[];
values(): any[];
pairs(): [string, any][];
entries(): [string, any][];
invert(): any;
pick(...args: any[]): any;
omit(...args: any[]): any;
isEmpty(): any;
has(attr: string): boolean;
matches(attrs: import("@converse/skeletor/src/types/model.js").Attributes): boolean;
set(key: string | any, val?: string | any, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
_changing: boolean;
_previousAttributes: any;
id: any;
_pending: boolean | import("@converse/skeletor/src/types/model.js").Options;
unset(attr: string, options?: import("@converse/skeletor/src/types/model.js").Options): false | any;
clear(options: import("@converse/skeletor/src/types/model.js").Options): false | any;
hasChanged(attr?: string): any;
changedAttributes(diff: any): any;
previous(attr?: string): any;
previousAttributes(): any;
fetch(options?: import("@converse/skeletor/src/types/model.js").Options): any;
save(key?: string | import("@converse/skeletor/src/types/model.js").Attributes, val?: boolean | number | string | import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): any;
destroy(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
url(): any;
parse(resp: import("@converse/skeletor/src/types/model.js").Options, options?: import("@converse/skeletor/src/types/model.js").Options): import("@converse/skeletor/src/types/model.js").Options;
isNew(): boolean;
isValid(options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
_validate(attrs: import("@converse/skeletor/src/types/model.js").Attributes, options?: import("@converse/skeletor/src/types/model.js").Options): boolean;
on(name: string, callback: (event: any, model: import("@converse/skeletor").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").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").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
once(name: string, callback: (event: any, model: import("@converse/skeletor").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").Model, collection: import("@converse/skeletor").Collection, options: Record<string, any>) => any): any;
trigger(name: string, ...args: any[]): any;
constructor: Function;
toString(): string;
toLocaleString(): string;
valueOf(): Object;
hasOwnProperty(v: PropertyKey): boolean;
isPrototypeOf(v: Object): boolean;
propertyIsEnumerable(v: PropertyKey): boolean;
};
} & typeof ChatBoxBase;
/**
* Represents a one-on-one chat conversation.
*/
declare class ChatBox extends ChatBox_base {
constructor(attrs: any, options: any);
/**
* @typedef {import('./message.js').default} Message
* @typedef {import('../muc/muc.js').default} MUC
* @typedef {import('../../shared/types').MessageAttributes} MessageAttributes
* @typedef {import('../../shared/errors').StanzaParseError} StanzaParseError
*/
defaults(): {
bookmarked: boolean;
hidden: boolean;
message_type: string;
num_unread: number;
time_opened: any;
time_sent: string;
type: string;
};
initialize(): Promise<void>;
initialized: Promise<any> & {
isResolved: boolean;
isPending: boolean;
isRejected: boolean;
resolve: (value: any) => void;
reject: (reason?: any) => void;
};
/**
* @param {string} jid
*/
setPresence(jid: string): Promise<void>;
presence: any;
/**
* @param {MessageAttributes|StanzaParseError} attrs_or_error
*/
onMessage(attrs_or_error: import("../../shared/types").MessageAttributes | import("../../shared/errors").StanzaParseError): Promise<void>;
/**
* @param {import('../roster/presence').default} item
*/
onPresenceChanged(item: import("../roster/presence").default): void;
close(): Promise<void>;
/**
* @returns {string|null}
*/
getDisplayName(): string | null;
/**
* @param {string} jid1
* @param {string} jid2
*/
isSameUser(jid1: string, jid2: string): any;
/**
* @param {MessageAttributes} attrs
*/
handleChatMarker(attrs: import("../../shared/types").MessageAttributes): boolean;
/**
* @param {MessageAttributes} [attrs]
* @return {Promise<MessageAttributes>}
*/
getOutgoingMessageAttributes(attrs?: import("../../shared/types").MessageAttributes): Promise<import("../../shared/types").MessageAttributes>;
canPostMessages(): boolean;
/**
* @param {import('../../shared/message').default} message
*/
isChatMessage(message: import("../../shared/message").default<any>): boolean;
}
import ChatBoxBase from '../../shared/chatbox.js';
//# sourceMappingURL=model.d.ts.map