File

src/lib/core/plugin.ts

Index

Methods

Methods

afterReceiveMessage
afterReceiveMessage(message: Message, messageStanza: MessageWithBodyStanza, MessageReceivedEvent: MessageReceivedEvent)
Parameters :
Name Type Optional
message Message No
messageStanza MessageWithBodyStanza No
MessageReceivedEvent MessageReceivedEvent No
Returns : void
afterSendMessage
afterSendMessage(message: Message, messageStanza: Element)
Parameters :
Name Type Optional
message Message No
messageStanza Element No
Returns : void
beforeSendMessage
beforeSendMessage(messageStanza: Element, message?: Message)
Parameters :
Name Type Optional
messageStanza Element No
message Message Yes
Returns : void
handleStanza
handleStanza(stanza: Stanza)

True if the given stanza was handled by this plugin, false otherwise.

Parameters :
Name Type Optional
stanza Stanza No
Returns : boolean
onBeforeOnline
onBeforeOnline()

All onBeforeOnline-Promises have to be resolved before the chat service will emit the 'connected' state.

Returns : PromiseLike<any>
onOffline
onOffline()

Hook for plugins to clear up data.

Returns : void
import { Element } from 'ltx';
import { MessageReceivedEvent } from '../services/adapters/xmpp/plugins/message.plugin';
import { Message } from './message';
import { MessageWithBodyStanza, Stanza } from './stanza';

export interface ChatPlugin {

    /**
     * All onBeforeOnline-Promises have to be resolved before the chat service will emit the 'connected' state.
     */
    onBeforeOnline(): PromiseLike<any>;

    /**
     * Hook for plugins to clear up data.
     */
    onOffline(): void;

    /**
     * True if the given stanza was handled by this plugin, false otherwise.
     */
    handleStanza(stanza: Stanza): boolean;

    beforeSendMessage(messageStanza: Element, message?: Message): void;

    afterSendMessage(message: Message, messageStanza: Element): void;

    afterReceiveMessage(message: Message, messageStanza: MessageWithBodyStanza, MessageReceivedEvent: MessageReceivedEvent): void;
}

results matching ""

    No results matching ""