Start News Client Server Entwickler Downloads Forum Bugs Impressum

EasyChat v3.0.0 - Pluginsystem

Befehle des Clients

Inhaltsverzeichnis

1. Befehlsverzeichnis nach Kategorien

1.1. Away-System

Plugin empfängt:
Plugin sendet:

1.2. Chat/Eingabezeile

Plugin empfängt:
Plugin sendet:

1.3. Datenaustausch

Plugin empfängt:
Plugin sendet:

1.4. Informationen/Status

Plugin empfängt:
Plugin sendet:

1.5. Menüeinträge

Plugin empfängt:
Plugin sendet:

1.6. Nachrichten

Plugin empfängt:
Plugin sendet:

1.7. Sonstiges

Plugin empfängt:
Plugin sendet:


2. Beschreibung der empfangenen Befehle:

AwayMessageRead

ausgelöst, wenn ein fremder Client die eigene Away-Nachricht lesen will oder wenn die Away-Nachricht beim away-gehen gepostet wird

Kategorie: Away-System
Registrierung: AwayMessageRead (=> Registrierung für Ereignisse)
data: <user>
  • user - anfordernder Benutzer (leer, wenn man away geht)
data2: <awaymsg>
  • awaymsg - Away-Nachricht
Rückgabe: <awaymsg>
  • awaymsg - Away-Nachricht (eventuell geändert)

AwayMessageReceived

ausgelöst, wenn eine fremde Awaynachricht empfangen wurde
Hinweis: die Away-Nachrichten können mit GetAwayMessage angefordert werden, das Ereignis wird jedoch auch ohne eigene Anforderung ausgelöst

Kategorie: Away-System
Registrierung: AwayMessageReceived (=> Registrierung für Ereignisse)
data: <user>
  • user - Benutzer, dessen Away-Nachricht empfangen wurde
data2: <awaymsg>
  • awaymsg - Away-Nachricht
Rückgabe: leer

AwayMessageRequest

ausgelöst, wenn man away geht (zum Abfragen der Away-Nachricht)

Kategorie: Away-System
Registrierung: AwayMessageRequest (=> Registrierung für Ereignisse)
data: <awaymsg>
  • awaymsg - letzte Away-Nachricht
data2: leer
Rückgabe: [ <awaymsg> ]
  • awaymsg - Awaynachricht (leer, wenn EasyChat sich selber darum kümmern soll)

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

ClientStatus

ausgelöst, wenn sich der eigene Status ändert

Kategorie: Informationen/Status
Registrierung: ClientStatus (=> Registrierung für Ereignisse)
data: <status>
  • status - Status
    • adminchanged - der eigene Adminstatus wurde geändert
    • awaychanged - der eigene Awaystatus wurde geändert
    • colorchanged - die eigene Farbe wurde geändert
    • joined - ein Chatraum wurde betreten
    • left - ein Chatraum wurde verlassen
    • newuserlist - eine neue Personenliste ist angekommen
data2:
  • für adminchanged: <status>
    • status - Admin-Status
      • admin - Admin
      • noadmin - kein Admin
  • für awaychanged: <status> Chr$(0) [ <awaymsg> ]
    • status - Away-Status
      • away - away
      • normal - nicht away
    • awaymsg - Awaynachricht
  • für colorchanged: <color>
    • color - neue Farbe
  • für joined,left: <chatroom>
    • chatroom - Name des Chatraumes
  • für newuserlist: <chatroom> [ <user> Chr$(1) <color> Chr$(1) <away> Chr$(1) <admin> [ vbCrLf <user> Chr$(1) <color> Chr$(1) <away> Chr$(1) <admin> [ vbCrLf ... ] ] ]
    • chatroom - die eben eingetroffene Personenliste
    • user - Benutzername
    • color - Chatfarbe
    • away - Away-Status
    • admin - Admin-Status
Rückgabe: leer

Command

ausgelöst, wenn der Benutzer einen unbekannten Befehl eingegeben hat

Kategorie: Chat/Eingabezeile
Registrierung: Command (=> Registrierung für Ereignisse)
data: <command>
  • command - der eingegebene Befehl
data2: <data>
  • data - die hinter dem Befehl eingegebenen Daten
Rückgabe: [ <status> ]
  • status - Status wenn behandelt, leer sonst
    • done - behandelt

ConnectionStatus

ausgelöst, wenn sich der Status der Verbindung ändert

Kategorie: Informationen/Status
Registrierung: ConnectionStatus (=> Registrierung für Ereignisse)
data: <status>
  • status - neuer Status
    • connected - Verbindung hergestellt, angemeldet
    • disconnected - Verbindung getrennt
    • error - Verbindung wurde abnormal beendet oder wegen Fehler nicht hergestellt
    • loginfailed - Server wurde erreicht, aber die Anmeldung war nicht erfolgreich
data2:
  • für connected: <maxtextlen>
    • maxtextlen - Anzahl der Zeichen, die je Nachricht gesendet werden dürfen
  • für disconnected: <reason>
    • reason - Grund der Trennung
      • client - die Verbindung wurde clientseitig getrennt
      • server - die Verbindung wurde vom Server getrennt
  • für error: <errno> Chr$(0) <desc>
    • errno - Fehlernummer
    • desc - Fehlerbeschreibung
  • für loginfailed: <reason>
    • reason - Grund
      • denied - Zugang wurde verweigert (z.B. falsches Passwort)
      • noguests - Gastzugang ist nicht erlaubt
      • unsupported - die Protokollversion ist nicht kompatibel
      • used - der Benutzername ist bereits in Benutzung
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

DataFromServer

ausgelöst, wenn der Server Daten schickt

Kategorie: Datenaustausch
data: <command>
  • command - der Pluginbefehl
data2: <data>
  • data - Daten
Rückgabe: leer

IPsRequest

ausgelöst, um zusätzliche IPs zu ermitteln

Kategorie: Sonstiges
Registrierung: IPsRequest (=> Registrierung für Ereignisse)
data: leer
data2: leer
Rückgabe: [ <ip> [ vbCrLf <ip> [ vbCrLf ... ] ] ]
  • ip - IP

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

MessageSending

ausgelöst, bevor eine Nachricht gesendet wird
Hinweis: Wenn ein Leerstring zurückgegeben wird, so wird das Senden unterdrückt

Kategorie: Nachrichten
Registrierung: MessageSending (=> Registrierung für Ereignisse)
data: <type> Chr$(0) <receiver> [ vbCrLf <receiver> [ vbCrLf ... ] ] Chr$(0) <message>
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • private - private Nachricht
    • shout - /s-Nachricht
  • receiver - Empfänger (bei privaten Nachrichten genau einer)
  • message - Nachricht
data2: leer
Rückgabe: [ <type> Chr$(0) <receiver> [ vbCrLf <receiver> [ vbCrLf ... ] ] Chr$(0) <message> ]
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • private - private Nachricht
    • shout - /s-Nachricht
  • receiver - Empfänger (bei privaten Nachrichten genau einer)
  • message - Nachricht (evtl. geändert)

NewMessage

ausgelöst, wenn eine neue Nachricht angekommen ist
Hinweis: Wenn ein Leerstring zurückgegeben wird, so wird das Anzeigen unterdrückt

Kategorie: Nachrichten
Registrierung: NewMessage (=> Registrierung für Ereignisse)
data: <type> Chr$(0) [ <sender> Chr$(0) [ <receiver> Chr$(0) ] <chatcolor> Chr$(0) ] <Nachricht>
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • private - private Nachricht
    • shout - /s-Nachricht
    • system - System-Nachricht
  • sender - Absender (nicht bei system)
  • receiver - Empfänger (nur bei private)
  • chatcolor - Chatfarbe (nicht bei system)
  • Nachricht -
data2: leer
Rückgabe: [ <type> Chr$(0) [ <sender> Chr$(0) [ <receiver> Chr$(0) ] <chatcolor> Chr$(0) ] <Nachricht> ]
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • private - private Nachricht
    • shout - /s-Nachricht
    • system - System-Nachricht
  • sender - Absender (nicht bei system)
  • receiver - Empfänger (nur bei private)
  • chatcolor - Chatfarbe (nicht bei system)
  • Nachricht -

ServerPluginResponse

ausgelöst, wenn ein Plugin beim Server nicht ordnungsgemäß erreicht werden konnte

Kategorie: Datenaustausch
data: leer
data2: <status>
  • status - Status / Fehler
    • pluginnotfound - das Plugin wurde auf der Gegenseite nicht gefunden
Rückgabe: leer

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

UserMenuClick

ausgelöst, wenn auf einen Eintrag im Popup-Menü der Personenliste geklickt wurde

Kategorie: Menüeinträge
Registrierung: UserMenuEntry (=> Registrierung für Ereignisse)
data: <id>
  • id - ID des Menüeintrages
data2: <user>
  • user - Benutzer, auf den geklickt wurde
Rückgabe: leer

UserMenuEntries

ausgelöst, wenn die Einträge in das Popup-Menü der Personenliste erstellt werden sollen

Kategorie: Menüeinträge
Registrierung: UserMenuEntry (=> Registrierung für Ereignisse)
data: <user>
  • user - Benutzer, auf den geklickt wurde
data2: <user>
  • user - eigener Benutzername
Rückgabe: [ <label> Chr$(0) <id> Chr$(0) <active> Chr$(0) <checked> [ vbCrLf <label> Chr$(0) <id> Chr$(0) <active> Chr$(0) <checked> [ vbCrLf ... ] ] ]
  • label - Name
  • id - ID
  • active - Boolean-Wert: TRUE, wenn der Eintrag aktiviert ist
  • checked - Boolean-Wert: TRUE, wenn der Eintrag angekreuzt ist

UserStatus

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

Kategorie: Informationen/Status
Registrierung: UserStatus (=> Registrierung für Ereignisse)
data: <status>
  • status - Status
    • adminchanged - der Adminstatus des Benutzers hat sich geändert
    • awaychanged - der Awaystatus des Benutzers hat sich geändert
    • colorchanged - die Chatfarbe des Benutzers hat sich geändert
    • transferaborted - ein Dateitransfer wurde abgebrochen
    • transferfinished - ein Dateitransfer wurde beendet
    • transferrequest - ein anderer Benutzer will einen Dateitransfer beginnen
    • transferstarted - ein Dateitransfer wurde gestartet
    • userjoined - ein Benutzer hat den Chatraum betreten
    • userleft - ein Benutzer hat den Chatraum verlassen
data2:
  • für adminchanged: <user> Chr$(0) <admin>
    • user - Benutzername
    • admin - Admin-Status
      • admin - Admin
      • noadmin - kein Admin
  • für awaychanged: <user> Chr$(0) <away> Chr$(0) [ <awaymsg> ]
    • user - Benutzername
    • away - Away-Status
      • away - away
      • normal - nicht away
    • awaymsg - Away-Nachricht
  • für colorchanged: <user> Chr$(0) <color>
    • user - Benutzername
    • color - Chatfarbe
  • für transferaborted: <user> Chr$(0) <reason>
    • user - Benutzername
    • reason - Grund des Abbruchs
      • receiver_abort - Empfänger hat abgebrochen
      • receiver_timeout - Zeitüberschreitung beim Empfänger
      • sender_abort - Sender hat abgebrochen
      • sender_timeout - Zeitüberschreitung beim Sender
      • deny - Empfänger hat abgelehnt
      • error - Fehler bei Übertragung aufgetreten
  • für transferfinished,transferrequest,transferstarted: <user>
    • user - Benutzername
  • für userjoined: <user> Chr$(0) <color> Chr$(0) <chatroom> Chr$(0) <away> Chr$(0) <admin>
    • user - Benutzername
    • color - Chatfarbe
    • chatroom - Chatraum
    • away - Awaystatus
      • away - away
      • normal - nicht away
    • admin - Admin-Status
      • admin - Admin
      • noadmin - kein Admin
  • für userleft: <user> Chr$(0) <chatroom> Chr$(0) <reason>
    • user - Benutzername
    • chatroom - Chatraum
    • reason - Grund
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)

WindowStatus

ausgelöst, wenn sich der Status des Chatfensters ändert

Kategorie: Informationen/Status
Registrierung: WindowStatus (=> Registrierung für Ereignisse)
data: <status>
  • status - neuer Status des Fensters
    • closing - das Fenster soll geschlossen werden
    • gotfocus - das Fenster hat den Focus bekommen
    • lostfocus - das Fenster hat den Focus verloren
    • maximized - das Fenster wurde maximiert
    • minimized - das Fenster wurde minimiert
    • normal - das Fenster wurde wiederhergestellt
data2: leer
Rückgabe: leer


3. Beschreibung der gesendeten Befehle:

AddChatLine

fügt eine Zeile in den Chattext ein

Kategorie: Chat/Eingabezeile
data: [ <color> [ Chr$(0) <bold> [ Chr$(0) <italic> ] ] ]
  • color - Farbe, in der der Text eingefügt wird (Standard: schwarz)
  • bold - Boolean-Wert, TRUE für fette Darstellung (Standard: FALSE)
  • italic - Boolean-Wert, TRUE für kursive Darstellung (Standard: FALSE)
data2: <text>
  • text - Nachricht
Rückgabe: leer

AddEventHandler

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

Kategorie: Sonstiges
data: <event>
  • event - Ereignisklasse
data2: leer
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

AddSystemMessage

fügt eine formatierte Systemnachricht in den Chattext ein

Kategorie: Chat/Eingabezeile
data: [ <color> ]
  • color - Farbe, in der der Text eingefügt wird (Standard: schwarz)
data2: <text>
  • text - Nachricht
Rückgabe: leer

AwayMode

setzt den Away-Modus oder fragt ihn ab

Kategorie: Away-System
data: [ <mode> [ Chr$(0) <ask> ] ]
  • mode - neuer Away-Modus oder leer, falls keine Änderung gewünscht
    • away -
    • normal -
  • ask - Boolean-Wert, der angibt, ob beim Wechsel in den Away-Modus die Away-Nachricht abgefragt werden soll (wird in allen anderen Fällen ignoriert; Standard: TRUE)
data2: [ <awaymsg> ]
  • awaymsg - neue Awaynachricht (wenn in den Awaymodus gewechselt wird oder wenn die Away-Nachricht geändert werden soll)
Rückgabe: <status>
  • status - (alter) Status

ClearChat

löscht das Chatfenster

Kategorie: Chat/Eingabezeile
data: leer
data2: leer
Rückgabe: leer

Connect

stellt die Verbindung zum Server her

Kategorie: Informationen/Status
data: [ <server> [ : <Port> ] ]
  • server - der Zielserver oder der letzte benutzte Server
  • Port - der Port, auf dem der Server erreicht werden kann
data2: [ <user> [ Chr$(0) <pwd> [ Chr$(0) <chatroom> [ Chr$(0) <chatroompwd> [ Chr$(0) <create> ] ] ] ] ]
  • user - Benutzername
  • pwd - Login-Passwort
  • chatroom - Chatraum
  • chatroompwd - Chatraum-Passwort
  • create - Boolean-Wert: TRUE, wenn Chatraum erstellt werden soll
Rückgabe: <status>
  • status - Status
    • connected - schon verbunden
    • connecting - es wird schon versucht, zu verbinden
    • done - Befehl ausgeführt

Disconnect

trennt die Verbindung zum Server

Kategorie: Informationen/Status
data: <ask>
  • ask - Boolean-Wert: TRUE, wenn nachgefragt werden soll
data2: <reason>
  • reason - Nachricht, die vor dem Beenden gesendet werden soll
Rückgabe: <status>
  • status - Status
    • disconnected - schon getrennt
    • disconnecting - es wird schon versucht, zu trennen
    • done - Befehl ausgeführt

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

GetAwayMessage

startet eine Abfrage einer Awaynachricht
Hinweis: die Registrierung ist für das Empfangen der Nachricht per AwayMessageReceived notwendig

Kategorie: Away-System
Registrierung: AwayMessageReceived (=> Registrierung für Ereignisse)
data: [ <user> ]
  • user - Name oder leer, falls eigene Awaynachricht abgefragt werden soll
data2: leer
Rückgabe: ( <status> | <awaymsg> )
  • status - Status (wenn anderer Benutzer abgefragt)
    • notfound - der Benutzer wurde im aktuellen Chatraum nicht gefunden
    • sent - Anfrage wurde gesendet
  • awaymsg - eigene Awaynachricht (wenn Name leer ist)

GetChatText

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

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

GetClientInfo

fragt eine Information über den Client ab

Kategorie: Informationen/Status
data: <information>
  • information - gewünschte Information
    • active - Boolean-Wert, ob der Client den Fokus hat
    • bytesin - transferierte Daten
    • bytesout - transferierte Daten
    • chatcolor - aktuelle Chatfarbe
    • chatname - aktueller Benutzername
    • chatroom - aktueller Chatraum
    • hwnd - das Fensterhandle des Clientfensters
    • ips - alle IP-Adressen des Clients
    • minimized - Boolean-Wert, ob der Client minimiert ist
    • uptimeclient - Uptimes (in Sekunden)
    • uptimeonline - Uptimes (in Sekunden)
    • usercount - Anzahl der Benutzer im aktuellen Chatraum
    • version - die Client-Version
data2: leer
Rückgabe: <information>
  • information - die Information

GetIgnoreList

fragt die Liste der zu ignorierenden Personen ab

Kategorie: Informationen/Status
data: leer
data2: leer
Rückgabe: [ <user> [ Chr$(1) <user> [ Chr$(1) ... ] ] ]
  • user - Benutzername

GetInputText

gibt den Text der Eingabezeile zurück

Kategorie: Chat/Eingabezeile
data: <selected>
  • selected - Boolean-Wert, ob nur markierter Text zurückgegeben werden soll
data2: [ <private> ]
  • private - leer, wenn im Hauptfenster, sonst Name des privaten Gesprächspartners
Rückgabe: <text>
  • text - Text der Eingabezeile

GetServerInfo

fragt Informationen über den Server ab

Kategorie: Informationen/Status
data: <information>
  • information - die gewünschte Inofrmation
    • admin - Admin des Servers
    • adminmail - E-Mail-Adresse des Admins
    • ip - IP des Servers
    • maxtextlength - maximal erlaubte Nachrichtenlänge
    • port - Port des Servers
    • version - Version des Servers
data2: leer
Rückgabe: <information>
  • information - die Information

GetSpecialPath

fragt einen speziellen Pfad ab

Kategorie: Informationen/Status
data: <path>
  • path - Pfad-ID
    • configs - Pfad zu den Konfigurationsdateien
    • receivedfiles - Pfad zu den empfangenen Dateien
    • chats - Pfad zu den Chats
    • logs - Pfad zu den Protokollierungsdateien
data2: leer
Rückgabe: <path>
  • path - angeforderter Pfad

GetUserInfo

fragt eine Information über eine Person ab

Kategorie: Informationen/Status
data: <user>
  • user - Benutzername
data2: <information>
  • information - gewünschte Information
    • admin - Boolean-Wert, ob die Person den Admin-Status hat
    • away - Boolean-Wert, ob die Person away ist
    • checked - Boolean-Wert, ob die Person markiert ist (also Nachrichten an diese Person gesendet werden sollen)
    • color - Farbwert der Person
    • ignored - Boolean-Wert, ob die Person ignoriert wird
Rückgabe: [ <information> ]
  • information - die Information oder Leerstring, falls der Benutzer nicht gefunden oder eine falsche Eigenschaft angegeben wurde

GetUserList

erfragt eine Liste aller Benutzer im Chatraum

Kategorie: Informationen/Status
data: leer
data2: leer
Rückgabe: [ <user> [ Chr$(1) <user> [ Chr$(1) ... ] ] ]
  • user - Benutzername (leer, wenn noch keine Liste verfügbar)

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

ResetAutoawayCounter

setzt den Zeitzähler für das Autoaway zurück

Kategorie: Away-System
data: leer
data2: leer
Rückgabe: leer

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)

SendDataToServer

sendet Daten an den Server

Kategorie: Datenaustausch
data: <command>
  • command - Pluginbefehl
data2: <data>
  • data - Daten
Rückgabe: <status>
  • status - Status
    • invalid - kein Befehl angegeben
    • nologin - kann nicht senden, da nicht am Server angemeldet
    • sent - Daten gesendet

SendMessage

sendet eine Nachricht

Kategorie: Nachrichten
data: <type> Chr$(0) [ <receiver> [ vbCrLf <receiver> [ vbCrLf ... ] ] ]
  • type - Nachrichtentyp
    • normal - normale Nachricht
    • me - /me-Nachricht
    • private - private Nachricht
    • shout - /s-Nachricht
  • receiver - Empfänger (nicht angegeben: an alle markierten Benutzer; bei privaten Nachrichten genau einer)
data2: <message>
  • message - Nachricht
Rückgabe: <status>
  • status - Status
    • invalid - kein Empfänger bei privater Nachricht
    • invalidmsg - keine Nachricht angegeben
    • invalidtype - ungültiger Nachrichtentyp
    • nologin - Client kann nicht senden, da nicht am Server angemeldet
    • sent - gesendet

SetInputText

setzt den Text für die Eingabezeile

Kategorie: Chat/Eingabezeile
data: <text>
  • text - neuer Text für Eingabezeile
data2: <selected> [ Chr$(0) <Destination> ]
  • selected - Boolean-Wert, ob nur markierter Text ersetzt werden soll
  • Destination - leer, wenn im Hauptfenster, sonst Name des privaten Gesprächspartners
Rückgabe: leer

SetUserInfo

setzt eine Eigenschaft eines Benutzers

Kategorie: Informationen/Status
data: <user> Chr$(0) <property>
  • user - Benutzername
  • property - Eigenschaft
    • checked - Boolean-Wert, ob die Person markiert ist (also Nachrichten an diese Person gesendet werden sollen)
    • ignored - Boolean-Wert, ob die Person ignoriert wird
data2: <value>
  • value - neuer Wert
Rückgabe: <status>
  • status - Status
    • denied - wenn man versucht, eine Eigenschaft von sich selbst zu ändern, das aber nicht erlaubt ist
    • done - Eigenschaft geändert
    • notfound - Benutzer nicht gefunden oder ungültige Eigenschaft

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


4. Ereignisklassen:

Ereignisklasse: AwayMessageReceived
Beschreibung: fängt empfangene Awaynachrichten anderer Personen ab
Ereignisse: AwayMessageReceived


Ereignisklasse: AwayMessageRequest
Beschreibung: fängt Anfragen der eigenen Awaynachricht ab (auch wenn der Benutzer away geht)
Ereignisse: AwayMessageRequest


Ereignisklasse: ClientStatus
Beschreibung: fängt Nachrichten über den eigenen Status ab
Ereignisse: ClientStatus


Ereignisklasse: Command
Beschreibung: fängt beim Client unbekannte Befehle ab, die in der Chatzeile eingegeben wurden
Ereignisse: Command


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


Ereignisklasse: IPsRequest
Beschreibung: ausgelöst, um zusätzliche IPs zu ermitteln
Ereignisse: IPsRequest


Ereignisklasse: MessageSending
Beschreibung: fängt Nachrichten ab bevor sie gesendet werden und erlaubt, sie zu ändern
Ereignisse: MessageSending


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


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


Ereignisklasse: UserMenuEntry
Beschreibung: ermöglicht Einträge in das Popup-Menü der Personenliste
Ereignisse: UserMenuClick, UserMenuEntries


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


Ereignisklasse: WindowStatus
Beschreibung: fängt Zustandsänderungen des Clientfensters ab
Ereignisse: WindowStatus