TeamSpeak-API 1.5.2

Lizenzbestimmungen
Freie Lizenz
Website
https://hanashi.eu
Unterstützte Versionen
WoltLab Suite 3.0
WoltLab Suite 3.1

Dieses Plugin dient als Schnittstelle zwischen weiteren Plugins und Ihrem TeamSpeak-Server. Dieses Plugin ist vor allem für Entwickler relevant. Es kann allerdings auch als Basis-Plugin für andere Plugins dienen.

Es können verschiedenen Server-Verbindungen eingestellt werden, auf diese dann von anderen Plugins zugegriffen werden können.

Fragen und Antworten

Wie erstelle ich eine neue Verbindung?

Gehe ins ACP -> Konfiguration -> TeamSpeak -> Server -> TeamSpeak-Server hinzufügen.

Wie kann ich die API in meinem Plugin implementieren?

Füge die Abhängigkeit zu diesem Plugin in deiner package.xml ein:

XML: package.xml
  1. <requiredpackage minversion="1.5.2">eu.hanashi.wsc.teamspeak-api</requiredpackage>

Lass deine Nutzer die Serververbindung im ACP mit Hilfe der option.xml auswählen:

XML: option.xml
  1. <option name="my_plugin_teamspeak_identity">
  2. <categoryname>my_category</categoryname>
  3. <optiontype>TeamSpeakConnectionSelect</optiontype>
  4. </option>

Den Namen (im Beispiel my_plugin_teamspeak_identity) und die richtige Kategorie (im Beispiel my_category) musst du natürlich selbst wählen.

Nun erstellst du eine PHP-Klasse im Verzeichnis lib/system/teamspeak welche die Klasse AbstractTeamSpeakHandler erbt:

PHP: MyPluginTeamSpeakHandler.class.php
  1. <?php
  2. namespace wcf\system\teamspeak;
  3. class MyPluginTeamSpeakHandler extends AbstractTeamSpeakHandler {
  4. protected $teamspeakID = MY_PLUGIN_TEAMSPEAK_IDENTITIY;
  5. }

Den Datei- und Klassennamen darfst du natürlich selbst wählen. Vergiss dabei nicht die richtige Konstante anstatt MY_PLUGIN_TEAMSPEAK_IDENTITIY einzusetzen.

Nun kannst du in anderen Klassen auf die TeamSpeak-API zugreifen. Hier ein Beispiel in einer Action-Klasse:

Wie führe ich einen TeamSpeak-Befehl aus?

Der TeamSpeak-Befehl ist immer gleich der Methode. Die Parameter werden als Array an die Parameter übergeben. Hier einige Beispiele:

Images

  • Version 1.5.2

    • FIX: Download und Upload von Dateien
  • Version 1.5.1

    • FIX: wenn Datei beim Filetransfer nicht gefunden wurde, wird nun Exception geworfen
  • Version 1.5.0

    • FEATURE: es wird nun libssh2 anstatt phpseclib verwendet, wenn dieses installiert ist.
  • Version 1.4.1

    • FIX: Fehler beim Anlegen einer neuen Verbindung im ACP
  • Version 1.4.0

    • CHANGE: Datenbank-Datentypen sinnvoll geändert
    • CHANGE: Klasse TeamSpeak umbenannt in TeamSpeakConnectionHandler und verweist nun auf TeamSpeakRawHandler undTeamSpeakSshHandler
  • Version 1.3.0

    • FEATURE: Berechnung der korrekten Icon-ID hinzugefügt (siehe TeamSpeakUtil::getCorrectIconID())
    • FEATURE: Snapshot-Funktionalität hinzugefügt (siehe AbstractTeamSpeakHandler::createSnapshot() und AbstractTeamSpeakHandler::deploySnapshot())
    • FIX: Filetransfer kann nun auch mit großen Dateien arbeiten
  • Version 1.2.0

    • FEATURE: das Filetransfer Protokoll von TeamSpeak kann nun genutzt werden (siehe: AbstractTeamSpeakHandler::uploadFile() und AbstractTeamSpeakHandler::downloadFile())
    • FEATURE: Methode zum Berechnen der Client Base64 UID hinzugefügt (siehe TeamSpeakUtil::generateClientBase64UID())
    • FEATURE: wenn Debug-Modus vom WSC aktiv ist, werden selbst abgefangene Exceptions geloggt (siehe ACP -> Verwaltung -> Fehler)
  • Version 1.1.0

    • CHANGE: Umstellung auf phpseclib, es ist nun nicht mehr notwendig die PHP-Erweiterung libssh2 auf dem Webserver installiert zu haben.


    Vielen Dank an Morik für die Hilfe bei der Umsetzung.

  • Version 1.0.0