mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-01-12 22:46:38 +08:00
* Definitions for strophe.js, as suggested in PR #27682. * [strophe.js] Make all 'Function' types from muc.d.ts more specific. * [strophe.js] enable as many lint rules as possible. * [strophe.js] fix the headers. * [strophe.js] More cleanup to enable more tslint rules.
This commit is contained in:
Tijs Zwinkels - TinkerTank
committed by
Andy
Andy
parent
2bd9965877
commit
3cd87a2953
1129
types/strophe.js/index.d.ts
vendored
Normal file
1129
types/strophe.js/index.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load Diff
848
types/strophe.js/muc.d.ts
vendored
Normal file
848
types/strophe.js/muc.d.ts
vendored
Normal file
@@ -0,0 +1,848 @@
|
||||
import { Strophe } from "strophe.js";
|
||||
|
||||
declare module "strophe.js" {
|
||||
namespace Strophe {
|
||||
interface Connection {
|
||||
muc: MUC.Plugin;
|
||||
}
|
||||
|
||||
namespace MUC {
|
||||
|
||||
interface Plugin {
|
||||
|
||||
/**
|
||||
* Initialize the MUC plugin. Sets the correct connection object and
|
||||
* extends the namesace.
|
||||
*
|
||||
* @param conn - the connection instance.
|
||||
*/
|
||||
init(conn: Connection): void;
|
||||
|
||||
/**
|
||||
* Join a multi-user chat room
|
||||
*
|
||||
* @param room - The multi-user chat room to join.
|
||||
* @param nick - The nickname to use in the chat room. Optional
|
||||
* @param msg_handler_cb - The function call to handle messages from the specified chat room.
|
||||
* @param pres_handler_cb - The function call back to handle presence in the chat room.
|
||||
* @param roster_cb - The function call to handle roster info in the chat room
|
||||
* @param password - The optional password to use. (password protected rooms only)
|
||||
* @param history_attrs - Optional attributes for retrieving history
|
||||
* @param extended_presence - Optional XML for extending presence
|
||||
*/
|
||||
join(
|
||||
room: string,
|
||||
nick: string,
|
||||
msg_handler_cb: (stanza: Element, room: XmppRoom) => boolean,
|
||||
pres_handler_cb: (stanza: Element, room: XmppRoom) => boolean,
|
||||
roster_cb: (occupants: OccupantMap, room: XmppRoom) => boolean,
|
||||
password?: string,
|
||||
history_attrs?: any,
|
||||
extended_presence?: Element
|
||||
): void;
|
||||
|
||||
|
||||
/**
|
||||
* Leave a multi-user chat room
|
||||
*
|
||||
* @param room - The multi-user chat room to leave.
|
||||
* @param nick - The nick name used in the room.
|
||||
* @param handler_cb - Optional function to handle the successful leave.
|
||||
* @param exit_msg - optional exit message.
|
||||
* @return iqid - The unique id for the room leave.*
|
||||
*/
|
||||
leave(
|
||||
room: string,
|
||||
nick: string,
|
||||
handler_cb?: (stanza: Element) => boolean,
|
||||
exit_msg?: string
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Send a message to a room.
|
||||
*
|
||||
* @param) room - The multi-user chat room name.
|
||||
* @param nick - The nick name used in the chat room.
|
||||
* @param message - The plaintext message to send to the room.
|
||||
* @param html_message - The message to send to the room with html markup.
|
||||
* @param type - "groupchat" for group chat messages o "chat" for private chat messages
|
||||
* @return msgiq - the unique id used to send the message
|
||||
*/
|
||||
message(
|
||||
room: string,
|
||||
nick: string,
|
||||
message: string,
|
||||
html_message: string,
|
||||
type: "groupchat"|"chat"
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Convenience Function to send a Message to all Occupants
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param message - The plaintext message to send to the room.
|
||||
* @param html_message - Optional message to send to the room with html markup.
|
||||
* @param msgid - Optional unique ID which will be set as the 'id' attribute of the stanza
|
||||
* @return msgiq - the unique id used to send the message
|
||||
*/
|
||||
groupchat(
|
||||
room: string,
|
||||
message: string,
|
||||
html_message?: string,
|
||||
msgid?: string
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Send a mediated invitation.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param receiver - The invitation's receiver.
|
||||
* @param reason - Optional reason for joining the room.
|
||||
* @return msgiq - the unique id used to send the invitation
|
||||
*/
|
||||
invite(
|
||||
room: string,
|
||||
receiver: string,
|
||||
reason?: string
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Send a mediated multiple invitation.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param receivers - The invitation's receivers.
|
||||
* @param reason - Optional reason for joining the room.
|
||||
* @return msgiq - the unique id used to send the invitation
|
||||
*/
|
||||
multipleInvites(
|
||||
room: string,
|
||||
receivers: string[],
|
||||
reason?: string
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Send a direct invitation.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param receiver - The invitation's receiver.
|
||||
* @param reason - Optional reason for joining the room.
|
||||
* @param password - Optional password for the room.
|
||||
* @return msgiq - the unique id used to send the invitation
|
||||
*/
|
||||
directInvite(
|
||||
room: string,
|
||||
receiver: string,
|
||||
reason?: string,
|
||||
password?: string
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Queries a room for a list of occupants
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param success_cb - Optional function to handle the info.
|
||||
* @param error_cb - Optional function to handle an error.
|
||||
* @return id - the unique id used to send the info request
|
||||
*/
|
||||
queryOccupants(
|
||||
room: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (error: any) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Start a room configuration.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param handler_cb - Optional function to handle the config form.
|
||||
* @param error_cb - Optional function to handle an error.
|
||||
* @return id - the unique id used to send the configuration request
|
||||
*/
|
||||
configure(
|
||||
room: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Cancel the room configuration
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @return id - the unique id used to cancel the configuration.
|
||||
*/
|
||||
cancelConfigure(room: string): string;
|
||||
|
||||
|
||||
/**
|
||||
* Save a room configuration.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param config- Form Object or an array of form elements used to configure the room.
|
||||
* @param success_db - Optional function to handle success.
|
||||
* @param error_cb - Optional function to handle an error.
|
||||
* @return id - the unique id used to save the configuration.
|
||||
*/
|
||||
saveConfiguration(
|
||||
room: string,
|
||||
config: any,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Create an instance room.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param success_db - Optional function to handle success.
|
||||
* @param error_cb - Optional function to handle an error.
|
||||
* @return id - the unique id used to create the chat room.
|
||||
*/
|
||||
createInstantRoom(
|
||||
room: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Create a configured room.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param config - the configuration. ex: {"muc#roomconfig_publicroom": "0", "muc#roomconfig_persistentroom": "1"}
|
||||
* @param success_db - Optional function to handle success.
|
||||
* @param error_cb - Optional function to handle an error.
|
||||
* @return id - the unique id used to create the chat room.
|
||||
*/
|
||||
createConfiguredRoom(
|
||||
room: string,
|
||||
config: any,
|
||||
success_cb: (stanza: Element) => any,
|
||||
error_cb: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Set the topic of the chat room.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param topic - Topic message.
|
||||
*/
|
||||
setTopic(room: string, topic: string): void;
|
||||
|
||||
|
||||
/**
|
||||
* Changes the role of a member of a MUC room.
|
||||
* The modification can only be done by a room moderator. An error will be
|
||||
* returned if the user doesn't have permission.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param nick - The nick name of the user to modify.
|
||||
* @param role - The new role of the user.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
modifyRole(
|
||||
room: string,
|
||||
nick: string,
|
||||
role: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Kick a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param nick - The nick name of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
kick(
|
||||
room: string,
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Voice a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param nick - The nick name of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
voice(
|
||||
room: string,
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Mute a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param nick - The nick name of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
mute(
|
||||
room: string,
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Op a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param nick - The nick name of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
op(
|
||||
room: string,
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* De-Op a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param nick - The nick name of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
deop(
|
||||
room: string,
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Changes the affiliation of a member of a MUC room.
|
||||
* The modification can only be done by a room moderator. An error will be
|
||||
* returned if the user doesn't have permission.
|
||||
* Parameters:
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param jid - The jid of the user to modify.
|
||||
* @param affiliation - The new affiliation of the user.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
modifyAffiliation(
|
||||
room: string,
|
||||
jid: string,
|
||||
affiliation: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Ban a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param jid - The jid of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
ban(
|
||||
room: string,
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Member a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param jid - The jid of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
member(
|
||||
room: string,
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Revoke a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param jid - The jid of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
revoke(
|
||||
room: string,
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Owner a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param jid - The jid of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
owner(
|
||||
room: string,
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Admin a user.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param jid - The jid of the user to modify.
|
||||
* @param reason - Optional reason for the change.
|
||||
* @param handler_cb - Optional callback for success
|
||||
* @param error_cb - Optional callback for error
|
||||
* @return iq - the id of the mode change request.
|
||||
*/
|
||||
owner(
|
||||
room: string,
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
/**
|
||||
* Change the current users nick name.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param user - The new nick name.
|
||||
*/
|
||||
changeNick(room: string, user: string): void;
|
||||
|
||||
/**
|
||||
* Change the current users status.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param user - The current nick.
|
||||
* @param show - The new show-text.
|
||||
* @param status - The new status-text.
|
||||
*/
|
||||
setStatus(
|
||||
room: string,
|
||||
user: string,
|
||||
show: string,
|
||||
status: string
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Registering with a room.
|
||||
* @see http://xmpp.org/extensions/xep-0045.html#register
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param handle_cb - Function to call for room list return.
|
||||
* @param error_cb - Function to call on error.
|
||||
*/
|
||||
registrationRequest(
|
||||
room: string,
|
||||
handle_cb: (stanza: Element) => any,
|
||||
error_cb: (stanza: Element) => any
|
||||
): void;
|
||||
|
||||
|
||||
/**
|
||||
* Submits registration form.
|
||||
*
|
||||
* @param room - The multi-user chat room name.
|
||||
* @param fields - The form fields.
|
||||
* @param handle_cb - Function to call for room list return.
|
||||
* @param error_cb - Function to call on error.
|
||||
*/
|
||||
submitRegistrationForm(
|
||||
room: string,
|
||||
fields: any,
|
||||
handle_cb: (stanza: Element) => any,
|
||||
error_cb: (stanza: Element) => any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* List all chat room available on a server.
|
||||
*
|
||||
* @param server - name of chat server.
|
||||
* @param handle_cb - Function to call for room list return.
|
||||
* @param error_cb - Function to call on error.
|
||||
*/
|
||||
listRooms(
|
||||
server: string,
|
||||
handle_cb: (stanza: Element) => any,
|
||||
error_cb: (error: any) => any
|
||||
): void;
|
||||
}
|
||||
|
||||
interface XmppRoom {
|
||||
|
||||
join(
|
||||
msg_handler_cb: (stanza: Element) => any,
|
||||
pres_handler_cb: (stanza: Element) => any,
|
||||
roster_cb: (stanza: Element) => any
|
||||
): void;
|
||||
|
||||
|
||||
leave(
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
exit_msg?: string
|
||||
): void;
|
||||
|
||||
|
||||
message(
|
||||
message: string,
|
||||
html_message: string,
|
||||
type: "groupchat"|"chat"
|
||||
): string;
|
||||
|
||||
|
||||
groupchat(message: string, html_message?: string): string;
|
||||
|
||||
|
||||
invite(receiver: string, reason?: string): string;
|
||||
|
||||
|
||||
multipleInvites(receivers: string[], reason?: string): string;
|
||||
|
||||
|
||||
directInvite(receiver: string, reason?: string): string;
|
||||
|
||||
|
||||
configure(handler_cb: (stanza: Element) => any): string;
|
||||
|
||||
|
||||
cancelConfigure(): string;
|
||||
|
||||
|
||||
saveConfiguration(config: any): string;
|
||||
|
||||
|
||||
queryOccupants(success_cb: (stanza: Element) => any, error_cb: (stanza: Element) => any): void;
|
||||
|
||||
|
||||
setTopic(topic: string): string;
|
||||
|
||||
|
||||
modifyRole(
|
||||
nick: string,
|
||||
role: string,
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
kick(
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
voice(
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
mute(
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
op(
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
deop(
|
||||
nick: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
modifyAffiliation(
|
||||
jid: string,
|
||||
affiliation: string,
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
ban(
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
member(
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
revoke(
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
owner(
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
admin(
|
||||
jid: string,
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
changeNick(nick: string): string;
|
||||
|
||||
|
||||
setStatus(show: string, status: string): string;
|
||||
|
||||
|
||||
/**
|
||||
* Adds a handler to the MUC room.
|
||||
* Parameters:
|
||||
* @param handler_type - 'message', 'presence' or 'roster'.
|
||||
* @param handler - The handler function.
|
||||
* @return id - the id of handler.
|
||||
*/
|
||||
addHandler(
|
||||
handler_type: "presence"|"message"|"roster",
|
||||
handler: (stanza: Element) => any
|
||||
): number;
|
||||
|
||||
|
||||
/**
|
||||
* Removes a handler from the MUC room.
|
||||
* This function takes ONLY ids returned by the addHandler function
|
||||
* of this room. passing handler ids returned by connection.addHandler
|
||||
* may brake things!
|
||||
*
|
||||
* @param id - the id of the handler
|
||||
*/
|
||||
removeHandler(id: number): void;
|
||||
|
||||
}
|
||||
|
||||
|
||||
interface RoomConfig {
|
||||
parse(info?: Element): any;
|
||||
}
|
||||
|
||||
|
||||
interface OccupantInfo {
|
||||
nick?: string;
|
||||
affiliation?: string;
|
||||
role?: string;
|
||||
jid?: string;
|
||||
status?: string;
|
||||
show?: string;
|
||||
}
|
||||
|
||||
|
||||
interface Occupant extends OccupantInfo {
|
||||
|
||||
modifyRole(
|
||||
role: string,
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
kick(
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
voice(
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
mute(
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
op(
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
deop(
|
||||
reason?: string,
|
||||
handler_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
modifyAffiliation(
|
||||
affiliation: string,
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
ban(
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
member(
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
revoke(
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
owner(
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
|
||||
admin(
|
||||
reason?: string,
|
||||
success_cb?: (stanza: Element) => any,
|
||||
error_cb?: (stanza: Element) => any
|
||||
): string;
|
||||
|
||||
update(data: OccupantInfo): void;
|
||||
}
|
||||
|
||||
interface OccupantMap {
|
||||
[jid: string]: Occupant;
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
import _MUC = Strophe.MUC;
|
||||
declare global {
|
||||
namespace Strophe {
|
||||
namespace MUC {
|
||||
type Plugin = _MUC.Plugin;
|
||||
type XmppRoom = _MUC.XmppRoom;
|
||||
type RoomConfig = _MUC.RoomConfig;
|
||||
type OccupantInfo = _MUC.OccupantInfo;
|
||||
type Occupant = _MUC.Occupant;
|
||||
type OccupantMap = _MUC.OccupantMap;
|
||||
}
|
||||
}
|
||||
}
|
||||
118
types/strophe.js/strophe.js-tests.ts
Normal file
118
types/strophe.js/strophe.js-tests.ts
Normal file
@@ -0,0 +1,118 @@
|
||||
function log(msg: string): void {
|
||||
console.log(msg);
|
||||
}
|
||||
|
||||
function rawInput(data: string): void {
|
||||
log('RECV: ' + data);
|
||||
}
|
||||
|
||||
function rawOutput(data: string): void {
|
||||
log('SENT: ' + data);
|
||||
}
|
||||
|
||||
function onOwnMessage(msg: Element): boolean {
|
||||
console.log(msg);
|
||||
const elems = msg.getElementsByTagName('own-message');
|
||||
if (elems.length > 0) {
|
||||
const own = elems[0];
|
||||
const to = msg.getAttribute('to');
|
||||
const from = msg.getAttribute('from');
|
||||
const iq = $iq({
|
||||
to: from,
|
||||
type: 'error',
|
||||
id: msg.getAttribute('id')
|
||||
}).cnode(own).up().c('error', { type: 'cancel', code: '501' })
|
||||
.c('feature-not-implemented', { xmlns: 'urn:ietf:params:xml:ns:xmpp-stanzas' });
|
||||
|
||||
connection.sendIQ(iq);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function onMessage(msg: Element): boolean {
|
||||
const to = msg.getAttribute('to');
|
||||
const from = msg.getAttribute('from');
|
||||
const type = msg.getAttribute('type');
|
||||
const elems = msg.getElementsByTagName('body');
|
||||
|
||||
if (type === "chat" && elems.length > 0) {
|
||||
const body = elems[0];
|
||||
|
||||
log('ECHOBOT: I got a message from ' + from + ': ' +
|
||||
Strophe.getText(body));
|
||||
|
||||
const text = Strophe.getText(body) + " (this is echo)";
|
||||
|
||||
log('ECHOBOT: I sent ' + from + ': ' + Strophe.getText(body));
|
||||
}
|
||||
|
||||
// we must return true to keep the handler alive.
|
||||
// returning false would remove it after it finishes.
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
function sendMessage() {
|
||||
const message = "some message";
|
||||
const to = "some recipient";
|
||||
if (message && to) {
|
||||
const reply = $msg({
|
||||
to: to,
|
||||
type: 'chat'
|
||||
})
|
||||
.cnode(Strophe.xmlElement('body', message)).up()
|
||||
.c('active', { xmlns: "http://jabber.org/protocol/chatstates" });
|
||||
|
||||
connection.send(reply);
|
||||
|
||||
log('I sent ' + to + ': ' + message);
|
||||
}
|
||||
}
|
||||
|
||||
const connection = new Strophe.Connection("someservice");
|
||||
connection.rawInput = rawInput;
|
||||
connection.rawOutput = rawOutput;
|
||||
|
||||
function onConnect(status: Strophe.Status): void {
|
||||
if (status === Strophe.Status.CONNECTING) {
|
||||
log('Strophe is connecting.');
|
||||
} else if (status === Strophe.Status.CONNFAIL) {
|
||||
log('Strophe failed to connect.');
|
||||
} else if (status === Strophe.Status.DISCONNECTING) {
|
||||
log('Strophe is disconnecting.');
|
||||
} else if (status === Strophe.Status.DISCONNECTED) {
|
||||
log('Strophe is disconnected.');
|
||||
} else if (status === Strophe.Status.CONNECTED) {
|
||||
log('Strophe is connected.');
|
||||
log('ECHOBOT: Send a message to ' + connection.jid +
|
||||
' to talk to me.');
|
||||
|
||||
connection.addHandler(onMessage, null, 'message', null, null, null);
|
||||
connection.addHandler(onOwnMessage, null, 'iq', 'set', null, null);
|
||||
connection.send($pres().tree());
|
||||
}
|
||||
}
|
||||
|
||||
function onRoomMessage(stanza: Element, room: Strophe.MUC.XmppRoom): boolean {
|
||||
console.log(Strophe.serialize(stanza));
|
||||
room.groupchat("hello");
|
||||
return true;
|
||||
}
|
||||
|
||||
function onRoomPresence(stanza: Element, room: Strophe.MUC.XmppRoom): boolean {
|
||||
const from = stanza.getAttribute("from");
|
||||
console.log(`${from} precense updated`);
|
||||
return true;
|
||||
}
|
||||
|
||||
function onRoomRoster(occupants: Strophe.MUC.OccupantMap, room: Strophe.MUC.XmppRoom): boolean {
|
||||
for (const nick of Object.keys(occupants)) {
|
||||
const occupant = occupants[nick];
|
||||
console.log(occupant.nick, occupant.show, occupant.status);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
connection.muc.init(connection);
|
||||
connection.muc.join("room", "nick", onRoomMessage, onRoomPresence, onRoomRoster);
|
||||
25
types/strophe.js/tsconfig.json
Normal file
25
types/strophe.js/tsconfig.json
Normal file
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6",
|
||||
"dom"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": false,
|
||||
"strictFunctionTypes": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"muc.d.ts",
|
||||
"strophe.js-tests.ts"
|
||||
]
|
||||
}
|
||||
15
types/strophe.js/tslint.json
Normal file
15
types/strophe.js/tslint.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json",
|
||||
"rules": {
|
||||
"no-declare-current-package": false,
|
||||
"no-padding": false,
|
||||
"no-self-import": false,
|
||||
"object-literal-shorthand": false,
|
||||
"no-trailing-whitespace": false,
|
||||
"typedef-whitespace": false,
|
||||
"jsdoc-format": false,
|
||||
"no-consecutive-blank-lines": false,
|
||||
"prefer-template": false,
|
||||
"prefer-switch": false
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user