src/lib/core/plugin.ts
Methods |
afterReceiveMessage | ||||||||||||
afterReceiveMessage(message: Message, messageStanza: MessageWithBodyStanza, MessageReceivedEvent: MessageReceivedEvent)
|
||||||||||||
Defined in src/lib/core/plugin.ts:27
|
||||||||||||
Parameters :
Returns :
void
|
afterSendMessage | |||||||||
afterSendMessage(message: Message, messageStanza: Element)
|
|||||||||
Defined in src/lib/core/plugin.ts:25
|
|||||||||
Parameters :
Returns :
void
|
beforeSendMessage | |||||||||
beforeSendMessage(messageStanza: Element, message?: Message)
|
|||||||||
Defined in src/lib/core/plugin.ts:23
|
|||||||||
Parameters :
Returns :
void
|
handleStanza | ||||||
handleStanza(stanza: Stanza)
|
||||||
Defined in src/lib/core/plugin.ts:21
|
||||||
True if the given stanza was handled by this plugin, false otherwise.
Parameters :
Returns :
boolean
|
onBeforeOnline |
onBeforeOnline()
|
Defined in src/lib/core/plugin.ts:11
|
All onBeforeOnline-Promises have to be resolved before the chat service will emit the 'connected' state.
Returns :
PromiseLike<any>
|
onOffline |
onOffline()
|
Defined in src/lib/core/plugin.ts:16
|
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;
}