nikeee
commented
9 years ago The notification system is pretty much the same as in gwTumm/node-teamspeak.
The TeamSpeak 3 Query API provides a way to register notifications that will be sent to the client. A common example for this is the notification that occurrs as soon as someone messages or pokes the query client.
Quoting the docs:
Registers for a specified category of events on a virtual server to receive notification messages. Depending on the notifications you've registered for, the server will send you a message on every event in the view of your ServerQuery client (e.g. clients joining your channel, incoming text messages, server configuration changes, etc). The event source is declared by the event parameter while id can be used to limit the notifications to a specific channel.
To tell the server that you want to get notified when a specific event occurs, you need to send a servernotifyregister message:
client.send("servernotifyregister", {
event: "textprivate" /* event type (see ts3 query docs) */
}, [/* no options */]);As soon as the server responds with a success message, the client emit the event with the name that was passed to the event parameter. Depending on the event you registered, there are several parameters that come with the event.
To add an event listener to the textprivate event that was previously registered on the server do this:
client.on("textprivate", function(data) {
/* this callback gets invoked */
console.log("Got private message!");
console.dir(data); // print out event-specific data
});If you don't want to be notified anymore about some event, you can send the servernotifyunregister message:
client.send("servernotifyunregister", {
event: "textprivate" /* event type (see ts3 query docs) */
}, [/* no options */]);Note that the event listener is still there if you don't remove it, but it certanly won't get fired since you told the server not to send these anymore. If you want to get rid of them, too, you can use the standard nodejs removeAllListeners:
client.removeAllListeners("textprivate");However, there are events that don't need to be registered, for exampe error, timeout and close. These events depend on the underlying TCP socket connection status, so no approval/registration by the server is needed.
client.on("timeout", function(){
console.log("Connection timed out. :/");
});For a list of all exposed events by the Query API, have a look at the docs.
To conclude, you can to something like this:
client.send("servernotifyregister", { event: "textprivate" }, []).then(() => {
console.log("notification successfully registered");
console.log("Creating local event handler");
client.on("textprivate", data => {
console.log("Got private message!");
console.dir(data); // print out event-specific data
});
});I'll put these samples in the readme.
Note: The event type that needs to be passed to the server to register the notification isnt always the same string as the one you use for your local event handler. E.g. you can register an event of type "server" and then hook up an event handler that handles "clientmove".
Sir-Will
hey,
could you show me an example for events? I don't understand how to use them. (in node.js)