[mitchatten]

Webchat

URL

Die URL für den Zugriff auf Chaninfo lautet:

https://api.relay-chat.de/2/webchat/:channel/

Parameter

Der Parameter, der dieser URL übergeben werden muss, ist channel. Weitere mögliche (und nötige) Parameter können der unten stehenden Auflistung entnommen werden. Die im Normalfall voranstehende # (Raute) muss entfernt werden.

Ausgeliefert wird ein funktionsfähiges Script zum Einbinden von lightIRC mittels swfobject. Um etwas Traffic zu sparen, liefern wir das Script mit YUI Compressor komprimiert aus. Eingebunden wird der Aufruf mittels des <script>-Tags.


container

Gibt den Container (<div id="container">) an in welchen der Webchat-Code geschrieben wird.

Achtung: Dieser Parameter muss in der Form ?container=:container angegeben werden.


swfobject

Gibt an, ob swfobject mit ausgeliefert werden (true) oder nicht (false).


embed

Soll der Code zum einbetten (swfobject.embed(...)) mit ausgeliefert werden?


nick

Welcher Nick soll per Default gesetzt werden. Standardmässig wird ein zufällig generierter Nickname ausgegeben.


design

Das Design von lightIRC. Mögliche Werte sind: black, blue, darkorange, green, lightblue, yellow


language

Die zu verwendende Sprache. Mögliche Werte sind: bd (Bengali), bg (Bulgarian), br (Brazilian Portuguese), cz (Czech), da (Danish), de (German), el (Greek), en (English), es (Spanish), et (Estonian), fr (French), hu (Hungarian), it (Italian), ja (Japanese), nl (Dutch), pl (Polish), ro (Romanian), ru (Russian), sl (Slovenian), sq (Albanian), sr_cyr (Serbian Cyrillic), sr_lat (Serbian Latin), sv (Swedish), th (Thai), tr (Turkish), uk (Ukrainian)


sound

Gibt an, ob bei Privaten Nachrichten (Queries) ein Hinweiston erklingen soll. Queries können mit dem Parameter queries komplett abgeschaltet werden.


navigation

Gibt an, ob die Nagigation (Menü, Channel-Zentrale, ...) angezeigt werden soll.


navposition

Gibt an, wo die Navigations-Leiste angezeigt werden soll. Mögliche Werte sind: left, right, top, bottom


nickprefixes

Gibt an, ob die Nicknamen in Chat-Texten jeweils mit <und > umschlossen werden.


queries

Gibt an, ob Queries erlaubt sind oder diese komplett abgeschaltet werden sollen.


userlisticons

Gibt an, ob die Prefixes (*, !, @, %, +) durch Bilder ersetzt werden sollen.


fontsize

Gibt die Text-Größe der Texte an.


userlistwidth

Gibt die Breite der Nutzer-Liste im Channel an (in Pixel).


emoticons

Gibt an, ob Emoticons eingeschaltet werden sollen.


awc

Gibt an, ob der Webchat für Afterworkchat generiert wird.

Beispiel

Der Link zum Webchat-Script mit allen Defaults würde – hier für den Channel #iZ-smart – so aussehen:

https://api.relay-chat.de/2/webchat/iZ-smart/?container=lightIRC& \
  swfobject=true&embed=true&nick=iZ-smart_API&design=lightblue& \
  language=de&sound=true&navigation=true&navposition=bottom& \
  nickprefixes=true&queries=true&userlisticons=false&fontsize=11& \
  userlistwidth=175&emoticons=false

Achtung: Dieser Link muss mittels JavaScript (mittels des <script>-Tags) auf einer bestehenden Webseite eingebunden werden. Ein direkter Link zu einem Webchat ist nicht möglich!

Die Zeilenumbrüche die hier mit einem \ markiert sind müssen entfernt werden. Es wurde hier nur der Übersicht halber umgebrochen.

Dein ganz persönliches Webchat-Script kannst du dir mit dem Webchat-Generator zusammenstellen. Dieser basiert zu 100% auf diesem Webchat.