Start News Client Server Entwickler Downloads Forum Bugs Impressum

EasyChat v3.0.0 - Pluginsystem

Befehle des Servers

Inhaltsverzeichnis

1. Befehlsverzeichnis nach Kategorien

1.1. Administration

Plugin empfängt:
Plugin sendet:

1.2. Benutzerverwaltung

Plugin sendet:

1.3. Chatraumverwaltung

Plugin empfängt:
Plugin sendet:

1.4. Datenaustausch

Plugin empfängt:
Plugin sendet:

1.5. Informationen/Status

Plugin empfängt:
Plugin sendet:

1.6. Log

Plugin sendet:

1.7. Menüeinträge

Plugin empfängt:
Plugin sendet:

1.8. Nachrichten

Plugin empfängt:
Plugin sendet:

1.9. Sonstiges

Plugin empfängt:
Plugin sendet:

2. Beschreibung der empfangenen Befehle:

AllowJoinChatroom

ausgelöst, wenn ein neuer Benutzer den Chatraum betreten will

Kategorie: Chatraumverwaltung
Registrierung: AllowJoinChatroom (=> Registrierung für Ereignisse)
data: <user>
  • user - Benutzername
data2: <chatroom>
  • chatroom - Chatraum
Rückgabe: <allow>
  • allow - Boolean-Wert: ob Person Chatraum betreten darf

ClientPluginResponse

ausgelöst, wenn ein Plugin bei einem anderen Client nicht ordnungsgemäß erreicht werden konnte

Kategorie: Datenaustausch
data: <receiver> [ Chr$(1) <receiver> [ Chr$(1) ... ] ]
  • receiver - Empfänger
data2: <status>
  • status - Status / Fehler
    • pluginnotfound - das Plugin wurde auf der Gegenseite nicht gefunden
    • usernotfound - der Benutzer wurde nicht gefunden
Rückgabe: leer

DataFromClient

ausgelöst, wenn ein (anderer) Client Daten schickt

Kategorie: Datenaustausch
data: <command> Chr$(0) <sender>
  • command - Pluginbefehl
  • sender - Absender
data2: <data>
  • data - Daten
Rückgabe: leer

DataFromPlugin

ausgelöst, wenn ein lokales Plugin Daten schickt

Kategorie: Datenaustausch
data: <command> Chr$(0) <sender>
  • command - Pluginbefehl
  • sender - Absender (Plugin-ID)
data2: <data>
  • data - Daten
Rückgabe: leer

DataFromPluginSynch

ausgelöst, wenn ein lokales Plugin Daten synchron schickt

Kategorie: Datenaustausch
data: <command> Chr$(0) <sender>
  • command - Pluginbefehl
  • sender - Absender (Plugin-ID)
data2: <data>
  • data - Daten
Rückgabe: <answer>
  • answer - Antwort für sendendes Plugin

MenuClick

ausgelöst, wenn auf einen Eintrag im Plugin-Menü geklickt wurde

Kategorie: Menüeinträge
data: <id>
  • id - ID des Menüeintrages
data2: leer
Rückgabe: leer

NewMessage

ausgelöst, wenn eine neue Nachricht angekommen ist (nicht bei Privaten)
Hinweis: Wenn ein Leerstring zurückgegeben wird, so wird das Senden unterdrückt

Kategorie: Nachrichten
Registrierung: NewMessage (=> Registrierung für Ereignisse)
data: <sender> Chr$(0) <chatroom>
  • sender - Absender
  • chatroom - Chatraum
data2: <type> Chr$(0) [ <receiver> [ vbCrLf <receiver> [ vbCrLf ... ] ] ] Chr$(0) <message>
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • shout - /s-Nachricht
  • receiver - weiterer Empfänger (leer, wenn an alle im Chatraum)
  • message - Nachricht
Rückgabe: [ <type> Chr$(0) [ <receiver> [ vbCrLf <receiver> [ vbCrLf ... ] ] ] Chr$(0) <message> ]
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • shout - /s-Nachricht
  • receiver - Empfänger (leer, wenn an alle im Chatraum)
  • message - Nachricht (eventuell verändert)

OnlineStatus

ausgelöst, wenn sich der Online-Status des Servers ändert

Kategorie: Informationen/Status
Registrierung: OnlineStatus (=> Registrierung für Ereignisse)
data: <status>
  • status - neuer Status
    • online - Server ist aktiv
    • offline - Server ist inaktiv
    • error - es ist ein Fehler aufgetreten
data2:
  • für error: <sock> Chr$(0) <error>
    • sock - Socket-Nummer
    • error - Windows-Fehlercode
  • für online: <ip> [ Chr$(1) <ip> [ Chr$(1) ... ] ] Chr$(0) <port>
    • ip - IP
    • port - Port
  • für offline: leer
Rückgabe: leer

QueryAdminStatus

ausgelöst, wenn ein neuer Benutzer den Chat betreten hat und sein Admin-Status festgestellt werden soll

Kategorie: Administration
Registrierung: QueryAdminStatus (=> Registrierung für Ereignisse)
data: <user>
  • user - Benutzername
data2: <chatroom>
  • chatroom - Chatraum
Rückgabe: <admin>
  • admin - Boolean-Wert: der Admin-Status

QueryChatname

ausgelöst, wenn ein neuer Benutzer den Server betreten hat und sein Benutzername festgelegt werden soll

Kategorie: Administration
Registrierung: QueryChatname (=> Registrierung für Ereignisse)
data: <user>
  • user - Benutzername
data2: <ip>
  • ip - IP des Benutzers
Rückgabe: [ <user> ]
  • user - eventuell geänderter Benutzername oder leer, wenn Benutzer nicht verbinden darf

QueryChatroom

ausgelöst, wenn ein Benutzer einen neuen Chatraum erstellen will

Kategorie: Chatraumverwaltung
Registrierung: QueryChatroom (=> Registrierung für Ereignisse)
data: <user>
  • user - Benutzername
data2: <chatroom>
  • chatroom - Chatraum
Rückgabe: [ <chatroom> ]
  • chatroom - eventuell geänderter Chatraumname oder leer, wenn Benutzer nicht erstellen darf

ServerCommand

ausgelöst, wenn der Client einen Server-Befehl gesendet hat

Kategorie: Nachrichten
Registrierung: ServerCommand (=> Registrierung für Ereignisse)
data: <command> Chr$(0) <sender>
  • command - Befehl
  • sender - Absender
data2: <data>
  • data - die hinter dem Befehl angegebenen Daten
Rückgabe: [ <status> ]
  • status - Status oder leer, wenn nicht behandelt
    • done - wenn behandelt

ShortcutPressed

ausgelöst, wenn im Hauptfenster oder "Private Nachrichten"-Fenster eine Tastenkombination gedrückt wurde

Kategorie: Sonstiges
Registrierung: ShortcutPressed (=> Registrierung für Ereignisse)
data: [ <user> ]
  • user - leer, wenn im Hauptfenster, sonst Name des privaten Gesprächspartners
data2: <shiftState> Chr$(0) <keyCode>
  • shiftState - gedrückte Zusatztasen
    • 0 - kein SHIFT, STRG, ALT gedrückt
    • 1 - SHIFT gedrückt
    • 2 - STRG gedrückt
    • 3 - SHIFT und STRG gedrückt
    • 4 - ALT gedrückt
    • 5 - SHIFT und ALT gedrückt
    • 6 - STRG und ALT gedrückt
    • 7 - SHIFT und STRG und ALT gedrückt
  • keyCode - Tasten-Code (vbKey...)
Rückgabe: leer

UserStatus

ausgelöst, wenn sich der Status eines Benutzers ändert oder ein Benutzer einen Chatraum betritt/verlässt

Kategorie: Informationen/Status
Registrierung: UserStatus (=> Registrierung für Ereignisse)
data: <status>
  • status - neuer Status
    • userjoined - ein Benutzer hat den Chatraum betreten
    • userleft - ein Benutzer hat den Chatraum verlassen
    • userloggedin - ein Benutzer hat sich auf dem Server angemeldet
    • userloggedout - ein Benutzer hat die Verbindung zum Server getrennt
data2:
  • für userjoined: <user> Chr$(0) <chatroom>
    • user - Benutzername
    • chatroom - Chatraum
  • für userleft: <user> Chr$(0) <chatroom> Chr$(0) <reason>
    • user - Benutzername
    • chatroom - Chatraum
    • reason - Grund
  • für userloggedin: <user> Chr$(0) <color>
    • user - Benutzername
    • color - Farbe
  • für userloggedout: <user> Chr$(0) <error>
    • user - Benutzername
    • error - Boolean-Wert, ob der Client wegen einem Netzwerkfehler getrennt wurde
Rückgabe: leer

WelcomeMessage

ausgelöst, wenn eine Welcome-Message gesendet (im Server) oder empfangen und angezeigt (im Client) werden soll

Kategorie: Nachrichten
Registrierung: WelcomeMessage (=> Registrierung für Ereignisse)
data: <welcome>
  • welcome - die Willkommensnachricht
data2: leer
Rückgabe: [ <welcome> ]
  • welcome - die evtl. geänderte Willkommensnachricht oder Leerstring, falls die Anzeige unterdrückt werden soll (letzteres nur Client)

3. Beschreibung der gesendeten Befehle:

AddBanRule

fügt einen Eintrag in die Bann-Listen hinzu

Kategorie: Administration
data: <banlist>
  • banlist - zu welcher Liste soll hinzugefügt werden
    • ip - bannt eine IP/einen IP-Bereich
    • nick - bannt einen exakten Benutzernamen
    • nickrange - bannt alle Benutzernamen, die den Text enthalten
data2: <entry>
  • entry - neuer Eintrag: die zu bannende IP (z.B. 127.0.0.1), der IP-Bereich (z.B. 127.*.*.* oder 127.0.0.0-127.255.255.255) oder der Benutzername
Rückgabe: <status>
  • status - Status
    • done - Eintrag erfolgreich hinzugefügt
    • exists - Eintrag existiert bereits
    • invalid - IP-Eintrag ist fehlerhaft

AddEventHandler

registriert das Plugin für diverse Ereignisse (mögliche Ereignisklassen

Kategorie: Sonstiges
data: <event>
  • event - Ereignisklasse
data2: leer
Rückgabe: leer

AddLogLine

fügt eine Zeile in die Serverlog ein

Kategorie: Log
data: [ <color> ]
  • color - Farbe
data2: <text>
  • text - Nachricht
Rückgabe: leer

AddMenuEntry

fügt einen Eintrag in das Plugin-Menü ein

Kategorie: Menüeinträge
data: <id>
  • id - ID, unter der der Menüeintrag angesprochen werden soll
data2: <label> [ Chr$(0) <checked> [ Chr$(0) <active> ] ]
  • label - Name
  • checked - Boolean-Wert: TRUE, wenn der Eintrag angekreuzt ist
  • active - Boolean-Wert: TRUE, wenn der Eintrag aktiviert ist
Rückgabe: leer

AllowAnonymousLogin

setzt die Erlaubnis, das Clients den Server ohne gültiges Login betreten können oder fragt diese ab

Kategorie: Benutzerverwaltung
data: [ <allow> ]
  • allow - neuer Wert oder Leerstring, falls keine Änderung gewünscht
    • allow - Anonymous Login erlaubt
    • deny - Anonymous Login verboten
data2: leer
Rückgabe: <allow>
  • allow - (alter) Status

AllowCreateChatroom

setzt die Erlaubnis, das Clients Chaträume erstellen dürfen oder fragt diese ab

Kategorie: Chatraumverwaltung
data: [ <allow> ]
  • allow - neuer Wert oder Leerstring, falls keine Änderung gewünscht
    • allow - Chatraum erstellen erlaubt
    • deny - Chatraum erstellen verboten
data2: leer
Rückgabe: <allow>
  • allow - (alter) Status

ClearLog

löscht das Logfenster

Kategorie: Log
data: leer
data2: leer
Rückgabe: leer

CreateChatroom

erstellt einen neuen Chatraum

Kategorie: Chatraumverwaltung
data: <chatroom> Chr$(0) <desc> Chr$(0) <pwd> Chr$(0) <permanent>
  • chatroom - Chatraumname
  • desc - Beschreibung
  • pwd - Passwort
  • permanent - Boolean-Wert, ob der Chatraum nach dem nächsten Serverstart wieder geladen wird
data2: leer
Rückgabe: <status>
  • status - Status
    • created - Chatraum erstellt
    • exists - es existiert bereits ein Chatraum dieses Namens
    • failed - es wurde kein Name angegeben

CreateUserAccount

erstellt einen neuen Account auf dem Server
Hinweis: der Account hat weder ein Passwort noch sonstige Eigenschaften! Standardmäßig ist der neue Account nicht aktiviert

Kategorie: Benutzerverwaltung
data: <user>
  • user - Name
data2: leer
Rückgabe: <status>
  • status - Status
    • created - Account erstellt
    • exists - es existiert bereits ein Account dieses Namens

EditMenuEntry

ändert einen Eintrag im Plugin-Menü

Kategorie: Menüeinträge
data: <id>
  • id - ID, unter der der Menüeintrag angesprochen werden soll
data2: <label> [ Chr$(0) <checked> [ Chr$(0) <active> ] ]
  • label - Name
  • checked - Boolean-Wert: TRUE, wenn der Eintrag angekreuzt ist
  • active - Boolean-Wert: TRUE, wenn der Eintrag aktiviert ist
Rückgabe: leer

GetActiveUserAccountList

fragt eine Liste aller gerade aktiven Benutzer-Accounts ab
Hinweis: diese Funktion gibt im Gegensatz zu den anderen Funktionen die Liste nur in Kleinbuchstaben zurück

Kategorie: Benutzerverwaltung
data: leer
data2: leer
Rückgabe: [ <user> [ Chr$(0) <user> [ Chr$(0) ... ] ] ]
  • user - Benutzername

GetChatroomInfos

fragt Informationen zu einem Chatraum ab

Kategorie: Chatraumverwaltung
data: <chatroom>
  • chatroom - Name des Chatraumes
data2: leer
Rückgabe: <pwd> Chr$(0) <volatile> Chr$(0) <count> Chr$(0) <desc>
  • pwd - Passwort
  • volatile - Boolean-Wert, ob der Chatraum von einem Benutzer erstellt wurde
  • count - Benutzeranzahl
  • desc - Beschreibung

GetChatroomList

fragt eine aktuelle Liste aller erstellter Chaträume ab

Kategorie: Chatraumverwaltung
data: leer
data2: leer
Rückgabe: [ <chatroom> [ Chr$(0) <chatroom> [ Chr$(0) ... ] ] ]
  • chatroom - Chatraum

GetLogText

gibt den kompletten Inhalt des Log-Fensters zurück (z.B. zum Abspeichern)

Kategorie: Log
data: <format>
  • format - Format
    • rtf - Rückgabe RTF-formatiert
    • text - Rückgabe als blanker Text
data2: leer
Rückgabe: <text>
  • text - der Text

GetServerInfo

fragt Informationen über den Server ab

Kategorie: Informationen/Status
data: <property>
  • property - die gewünschte Eigenschaft
    • admin - Admin des Servers
    • adminmail - E-Mail-Adresse des Admins
    • bytesin - transferierte Daten
    • bytesout - transferierte Daten
    • chatroomcount - Anzah der gerade aktiven Chaträume
    • connectioncount - Anzahl der gerade offenen Verbindungen
    • hwnd - das Fensterhandle des Serverfensters
    • ips - Liste aller IP-Adressen, an denen der Server lauscht
    • maxtextlength - maximale erlaubte Nachrichtenlänge
    • maxusercount - Anzahl der maximal auf dem Server erlaubten Benutzer
    • port - Port des Servers
    • uptimeserver - Uptimes (in Sekunden)
    • uptimeonline - Uptimes (in Sekunden)
    • usercount - Anzahl der gerade eingeloggten Benutzer
    • version - Version des Servers
data2: leer
Rückgabe: <value>
  • value - die Information

GetStandardChatroom

fragt den Standard-Chatraum ab

Kategorie: Chatraumverwaltung
data: leer
data2: leer
Rückgabe: <chatroom>
  • chatroom - Name des Standard-Chatraums

GetUserAccountInfo

fragt Eigenschaften eines Benutzer-Accounts ab

Kategorie: Benutzerverwaltung
data: <user>
  • user - Benutzerame
data2: <property> Rückgabe: [ <value> ]
  • value - Wert der Eigenschaft oder Leerstring, falls diese Eigenschaft bzw. der Account nicht existiert

GetUserAccountList

fragt eine Liste aller Benutzer-Accounts ab

Kategorie: Benutzerverwaltung
data: leer
data2: leer
Rückgabe: [ <user> [ Chr$(0) <user> [ Chr$(0) ... ] ] ]
  • user - Benutzername

GetUserInfo

ermittelt Informationen zu angemeldeten Benutzern

Kategorie: Informationen/Status
data: <user>
  • user - Benutzername
data2: <property>
  • property - anzufragende Eigenschaft
    • admin - Adminstatus
    • away - Awaystatus
    • chatcolor - Chatfarbe
    • chatroom - Chatraum
    • ip - die IP des Benutzers
    • since - Verbindungsdauer in Sekunden
    • version - benutzte Clientversion
Rückgabe: [ <value> ]
  • value - Wert der Eigenschaft oder Leerstring, falls diese Eigenschaft bzw. der Benutzer nicht existiert

GetUserList

erfragt eine Liste aller Personen auf dem Server/in einem Chatraum

Kategorie: Informationen/Status
data: [ <chatroom> ]
  • chatroom - Chatraum, oder leer wenn alle Personen auf Server anzeigen
data2: leer
Rückgabe: [ <user> [ Chr$(1) <user> [ Chr$(1) ... ] ] ]
  • user - Benutzername

GetWelcomeMessage

fragt die Willkommensnachricht ab

Kategorie: Administration
data: leer
data2: leer
Rückgabe: <welcome>
  • welcome - Willkommensnachricht

KickUser

trennt einen Benutzer vom Server

Kategorie: Administration
data: <user>
  • user - Benutzername
data2: <reason>
  • reason - Grund
Rückgabe: <status>
  • status - Status
    • kicked - Benutzer wurde getrennt
    • notfound - Benutzer wurde nicht gefunden

ListBanRules

listet alle Bann-Regeln eines bestimmten Typs auf

Kategorie: Administration
data: <type>
  • type - Typ
    • ip - IP/IP-Bereich
    • nick - exakter Benutzername
    • nickrange - alle Benutzernamen, die den Text enthalten
data2: leer
Rückgabe: [ <entry> [ Chr$(0) <entry> [ Chr$(0) ... ] ] ]
  • entry - Eintrag

ModifyChatroom

bearbeitet einen Chatraum

Kategorie: Chatraumverwaltung
data: <chatroom> Chr$(0) <property> Chr$(0) <permanent>
  • chatroom - Chatraumname
  • property - Eigenschaft
    • description - Beschreibung
    • password - Passwort
  • permanent - Boolean-Wert, ob die Änderungen nach dem nächsten Serverstart wieder geladen werden
data2: <value>
  • value - neuer Wert
Rückgabe: <status>
  • status - Status
    • invalid - ungültige Eigenschaft
    • modified - Chatraum erfolgreich geändert
    • notfound - der Chatraum existiert nicht

ModifyUserAccount

ändert eine Eigenschaft eines Benutzer-Accounts
Hinweis: Benutzerdefinierte Eigenschaften können jeden beliebigen Namen haben (außer den schon vergebenen Standardeigenschaften). Sie werden für alle Plugins gemeinsam verwaltet. Um Eindeutigkeit zu erzielen, sollten die Eigenschaften mit dem Namen des Plugins beginnen.

Kategorie: Benutzerverwaltung
data: <user> Chr$(0) <property>
  • user - Benutzername
  • property - Eigenschaft
    • Active - Boolean-Wert, der angibt, ob der Account zur Anmeldung genutzt werden kann (üblicherweise erst gesetzt, wenn ein Passwort vergeben ist)
    • Comment - die angezeigte Beschreibung zum Account
    • Password - das Passwort des Accounts
    • ... - oder eine beliebige benutzerdefinerte Eigenschaft
data2: <value>
  • value - neuer Wert
Rückgabe: <status>
  • status - Status
    • modified - Account geändert
    • notfound - Account nicht gefunden

RemoveBanRule

entfernt eine Bann-Regel

Kategorie: Administration
data: <type>
  • type - Typ
    • ip - IP/IP-Bereich
    • nick - Benutzername
data2: leer
Rückgabe: <status>
  • status - Status
    • done - Eintrag erfolgreich emtfernt
    • notfound - Eintrag existiert nicht

RemoveChatroom

entfernt einen Chatraum

Kategorie: Chatraumverwaltung
data: <chatroom> Chr$(0) <permanent>
  • chatroom - Chatraumname
  • permanent - Boolean-Wert, ob der Chatraum nach dem nächsten Serverstart wieder geladen wird
data2: <force>
  • force - Boolean-Wert, ob eventuelle Benutzer gezwungen werden sollen, den Chatraum zu verlassen
Rückgabe: <status>
  • status - Status
    • removed - Chatraum erfolgreich entfernt
    • notfound - der Chatraum existiert nicht
    • notempty - Chatraum wurde nicht entfernt, da er nicht leer ist (kann mit "True" in data2 übergangen werden)

RemoveEventHandler

deregistriert das Plugin für diverse Ereignisse

Kategorie: Sonstiges
data: <event>
  • event - Ereignisklasse
data2: leer
Rückgabe: leer

RemoveMenuEntry

löscht einen Eintrag aus dem Plugin-Menü

Kategorie: Menüeinträge
data: <id>
  • id - ID, unter der der Menüeintrag angesprochen werden soll
data2: leer
Rückgabe: leer

RemoveUserAccount

entfernt einen Benutzer-Account

Kategorie: Benutzerverwaltung
data: <user>
  • user - Benutzername
data2: leer
Rückgabe: <status>
  • status - Status
    • deleted - Account gelöscht
    • notfound - Account nicht gefunden

SendDataToClient

sendet Daten an einen (anderen) Client

Kategorie: Datenaustausch
data: <command> Chr$(0) [ <reveiver> <reveiver> [ Chr$(1) <reveiver> [ Chr$(1) ... ] ] ]
  • command - Pluginbefehl
  • reveiver - Empfänger (leer beim Server: an alle Benutzer auf dem Server; beim Client nicht optional)
  • reveiver - Empfänger
data2: <data>
  • data - Daten
Rückgabe: <status>
  • status - Status
    • invalid - kein Befehl oder keine Empfänger angegeben
    • nologin - kann nicht senden, da nicht am Server angemeldet (nur Client)
    • sent - Daten gesendet

SendDataToPlugin

sendet Daten an ein anderes lokales Plugin

Kategorie: Datenaustausch
data: <Pluginbefehl> Chr$(0) <receiver>
  • Pluginbefehl -
  • receiver - Empfänger (Plugin-ID)
data2: <data>
  • data - Daten
Rückgabe: <status>
  • status - Status
    • invalid - kein Befehl angegeben
    • notfound - das Plugin wurde nicht gefunden
    • sent - Daten gesendet

SendDataToPluginSynch

sendet synchron Daten an ein anderes lokales Plugin und wartet auf Antwort

Kategorie: Datenaustausch
data: <command> Chr$(0) <receiver>
  • command - Pluginbefehl
  • receiver - Empfänger (Plugin-ID)
data2: <data>
  • data - Daten
Rückgabe: [ <answer> ]
  • answer - Antwort vom anderen Plugin (leer, wenn Plugin nicht gefunden)

SendMessage

sendet eine Nachricht

Kategorie: Nachrichten
data: [ <receiver> [ vbCrLf <receiver> [ vbCrLf ... ] ] ]
  • receiver - Empfänger (leer, wenn an alle auf dem Server)
data2: <text>
  • text - Nachricht
Rückgabe: <status>
  • status - Status
    • invalidmsg - keine Nachricht angegeben
    • notsent - Server konnte nicht senden (z.B. niemand gefunden, an den gesendet werden könnte)
    • sent - gesendet

SetAdminStatus

ändert den Admin-Status eines Benutzers

Kategorie: Administration
data: <user>
  • user - Benutzername
data2: <admin>
  • admin - Boolean-Wert: der neue Status
Rückgabe: <status>
  • status - Status
    • done - Änderung übernommen
    • notfound - Benutzer nicht gefunden

SetStandardChatroom

setzt den Standard-Chatraum

Kategorie: Chatraumverwaltung
data: <chatroom>
  • chatroom - Name des neuen Standard-Chatraums
data2: leer
Rückgabe: leer

SetWelcomeMessage

setzt die Willkommensnachricht

Kategorie: Administration
data: <welcome>
  • welcome - neue Willkommensnachricht
data2: leer
Rückgabe: leer

ShowBalloonTooltip

zeigt einen Balloon-Tooltip auf dem Tray-Icon des Programms an
Hinweis: funktioniert nur Windows ME, 2000 und XP

Kategorie: Sonstiges
data: <icon> Chr$(0) <title>
  • icon - anzuzeigendes Icon
    • none - keins
    • info - Info-Icon
    • warning - Warnungs-Icon
    • error - Fehler-Icon
  • title - Title: max 64 Teichen
data2: <message>
  • message - Nachricht, max. 256 Zeichen
Rückgabe: leer

StartServer

schaltet den Server online

Kategorie: Informationen/Status
data: [ <port> ]
  • port - Port (wenn leer oder ungültig, dann Standardport)
data2: leer
Rückgabe: <status>
  • status - Status
    • done - Funktion ausgeführt
    • started - der Server ist bereits online

StopServer

schaltet den Server offline

Kategorie: Informationen/Status
data: <force>
  • force - Boolean-Wert, der angibt, ob eventuelle noch verbundene Benutzer getrennt werden sollen
data2: leer
Rückgabe: <status>
  • status - Status
    • done - Funktion ausgeführt
    • notempty - Server wurde nicht gestoppt, da er nicht leer ist (kann mit "True" in data übergangen werden)
    • stopped - der Server ist bereits offline

ThrowUser

wirft eine Person aus ihrem Chatraum

Kategorie: Administration
data: <user>
  • user - Benutzername
data2: <reason>
  • reason - Grund
Rückgabe: <status>
  • status - Status
    • done - erfolgreich
    • roomnotfound - Person in keinem Chatraum
    • usernotfound - Person wurde nicht gefunden

4. Ereignisklassen:

Ereignisklasse: AllowJoinChatroom
Beschreibung: ob Person einenChatraum betreten darf oder nicht
Ereignisse: AllowJoinChatroom

Ereignisklasse: NewMessage
Beschreibung: fängt neue Nachrichten ab und erlaubt, sie zu ändern
Ereignisse: NewMessage

Ereignisklasse: OnlineStatus
Beschreibung: fängt Ereignisse bzgl. des Verbindungsstatus ab
Ereignisse: OnlineStatus

Ereignisklasse: QueryAdminStatus
Beschreibung: bei Abfrage des Admin-Status
Ereignisse: QueryAdminStatus

Ereignisklasse: QueryChatname
Beschreibung: zum Überprüfen/Ändern des Benutzernamens beim Anmelden
Ereignisse: QueryChatname

Ereignisklasse: QueryChatroom
Beschreibung: zum Überprüfen/Ändern des Chatraumnamens beim Erstellen
Ereignisse: QueryChatroom

Ereignisklasse: ServerCommand
Beschreibung: fängt Server-Befehle vom Client ab, die in der Chatzeile eingegeben wurden
Ereignisse: ServerCommand

Ereignisklasse: ShortcutPressed
Beschreibung: fängt gedrückte Tastenkombinationen ab
Ereignisse: ShortcutPressed

Ereignisklasse: UserStatus
Beschreibung: fängt Nachrichten über neue Benutzer und Benutzer, die Farbe, Awaystatus oder Chatraum wechseln, ab
Ereignisse: UserStatus

Ereignisklasse: WelcomeMessage
Beschreibung: fängt die Willkommensnachricht ab und erlaubt es sie zu ändern
Ereignisse: WelcomeMessage
Entwickler Menü