TeamSpeak API 1.5.4

Hanashi
Jan 27th 2019
419 Downloads
4 Comments

License Agreement: Freie Lizenz
Website: https://hanashi.dev
Supported Versions: WoltLab Suite 3.0
WoltLab Suite 3.1
WoltLab Suite 5.2

This plugin serves as an interface between other plugins and your TeamSpeak server. This plugin is especially relevant for developers. It can also be used as a base plugin for other plugins.

Different server connections can be set, which can then be accessed by other plugins.

Prerequisites

WoltLab Suite Core 3.0/3.1

Questions and answers

How do I create a new connection?

Go to ACP -> configuration -> TeamSpeak -> Server -> add TeamSpeak server.

How can I implement the API in my plugin?

Add the dependency to this plugin to your package.xml:

XML: package.xml

<requiredpackage minversion="1.5.0">eu.hanashi.wsc.teamspeak-api</requiredpackage>

Let your users select the server connection in the ACP using the option.xml:

XML: option.xml

<option name="my_plugin_teamspeak_identity">
    <categoryname>my_category</categoryname>
    <optiontype>TeamSpeakConnectionSelect</optiontype>
</option>

The name (in the example my_plugin_teamspeak_identity) and the correct category (in the example my_category) have to be chosen by yourself.

Now create a PHP class in the directory lib/system/teamspeak which extends the class AbstractTeamSpeakHandler:

PHP: MyPluginTeamSpeakHandler.class.php

<?php
namespace wcf\system\teamspeak;

class MyPluginTeamSpeakHandler extends AbstractTeamSpeakHandler {
    protected $teamspeakID = MY_PLUGIN_TEAMSPEAK_IDENTITIY;
}

Of course you can choose the file and class name yourself. Don't forget to use the correct constant instead of MY_PLUGIN_TEAMSPEAK_IDENTITIY.

Now you can access the TeamSpeak API in other classes. Here is an example in an action class::

PHP: MyAction.class.php

<?php
namespace wcf\action;
use wcf\system\teamspeak\MyPluginTeamSpeakHandler;

class MyAction extends AbstractAction {
    public function execute() {
        parent::execute();

        // TeamSpeak command: serverlist
        $serverlist = MyPluginTeamSpeakHandler::getInstance()->serverlist();

        // TeamSpeak command: clientlist -uid -country
        $clientlist = MyPluginTeamSpeakHandler::getInstance()->clientlist(['-uid', '-country']);

        // TeamSpeak command: sendtextmessage targetmode=1 target=1 msg=Hello\sWorld!
        MyPluginTeamSpeakHandler::getInstance()->sendtextmessage(['targetmode' => 1, 'target' => 1, 'msg' => 'Hello World!']);
    }
}

Display More

How do I execute a TeamSpeak command?

The TeamSpeak command is always the same as the method. The parameters are passed to the parameters as an array. Here are some examples:

PHP

<?php
use wcf\system\teamspeak\MyPluginTeamSpeakHandler;

// TemSpeak command: serverlist
MyPluginTeamSpeakHandler::getInstance()->serverlist();

// TemSpeak command: clientlist -uid -away -groups
MyPluginTeamSpeakHandler::getInstance()->clientlist(['-uid', '-away', '-groups']);

// TemSpeak command: clientdbfind pattern=Hanashi
MyPluginTeamSpeakHandler::getInstance()->clientdbfind(['pattern' => 'Hanashi']);

// TemSpeak command: clientdbfind pattern=FPMPSC6MXqXq751dX7BKV0JniSo= -uid
MyPluginTeamSpeakHandler::getInstance()->clientdbfind(['pattern' => 'FPMPSC6MXqXq751dX7BKV0JniSo=', '-uid']);

// TemSpeak command: sendtextmessage targetmode=2 target=12 msg=Hello\sWorld!
MyPluginTeamSpeakHandler::getInstance()->sendtextmessage(['targetmode' => 2, 'target' => 12, 'msg' => 'Hello World!']);

Display More

Images

Version 1.5.4
- Jul 13th 2019
- 251.24 kB
- 186 Downloads
- CHANGE; Umstellung auf MEDIUMINT damit höhere Ports verwendet werden können
Version 1.5.3
- Jun 21st 2019
- 249.74 kB
- 25 Downloads
- FIX: Behebt Fehlermeldung wenn keine Verbindung zum TS-Server aufgebaut werden konnte
Version 1.5.2
- Mar 10th 2019
- 249.74 kB
- 145 Downloads
- FIX: Download and Upload of Files
- FIX: if file was not found during file transfer, exception is thrown no
Version 1.5.0
- Feb 17th 2019
- 249.71 kB
- 41 Downloads
- FEATURE: libssh2 is now used instead of phpseclib if this is installed
Version 1.4.1
- Feb 9th 2019
- 249.52 kB
- 17 Downloads
- CHANGE:Database data types meaningfully changed
- CHANGE: Class TeamSpeak renamed to TeamSpeakConnectionHandler and now refers to TeamSpeakRawHandler andTeamSpeakSshHandler

SeraphLP Sep 28th 2019

Sehr geiles Plugin
Ich habe nur ein einziges Problem:
Die User werden zwar synchronisiert, jedoch wenn sie auf dem Teamspeak reconnecten dann sind die nicht mehr synchronisiert.
- Hanashi Sep 28th 2019
  
  Hallo, die API synchronisiert nichts. Sie ist lediglich eine Schnittstelle für Entwickler.
Eisengrind Feb 23rd 2019

Kleine Idee für Entwickler:
Ein TS Bot der, wenn etwas in eine bestimmtes Forum gepostet wurde, daraufhin Member eine bestimmte TS Gruppe via Chat anschreibt, mit folgendem Inhalt:
Titel,
Anfangsteil des Inhalts und
Link zum Posting.

Quasi ein Notify Funktion für TS3.
- Hanashi Feb 23rd 2019
  
  Sowas ähnliches ist geplant, insofern TS5 global Chats bekommt. Dann wollte ich das wie beim Discord-Sync machen, dass neue Forenbeiträge in einen globalen Chat gepostet werden. Aber erstmal abwarten
  1

TeamSpeak API 1.5.4

Prerequisites

Questions and answers

How do I create a new connection?

Go to ACP -> configuration -> TeamSpeak -> Server -> add TeamSpeak server.

How can I implement the API in my plugin?

How do I execute a TeamSpeak command?

Images

Version 1.5.4

Version 1.5.3

Version 1.5.2

Version 1.5.0

Version 1.4.1

SeraphLP Sep 28th 2019

Hanashi Sep 28th 2019

Eisengrind Feb 23rd 2019

Hanashi Feb 23rd 2019

Bugtracker

Two Step Verification

Steam API

Discord-Sync

Discord API

Effective User Permission Viewer

Woltlab Suite Forum - Most helpful answer

VieCode Lexicon / Article system (WoltLab Suite)

Extended Conversations (Chat-System/cChat)

One-Time-Username

FAQ System (Frequently Asked Questions) for WoltLab Suite

Share