Difference between revisions of "Uri parameters"

From Mibbit Wiki
Jump to: navigation, search
m (widget)
m
Line 1: Line 1:
 
{{widget}}
 
{{widget}}
  
You can control the look/behavior of mibbit by calling it with various parameters in the uri ("GET"):
+
You can control the look/behavior of mibbit by calling it with various parameters in the uri (like .../?param1=value1&param2=value2&..., see examples):
 
==widget==
 
==widget==
 
* authmethod (default: nickserv, alternatives: auth or pass)
 
* authmethod (default: nickserv, alternatives: auth or pass)
Line 29: Line 29:
 
==main client==
 
==main client==
 
these will only result in a [[pre-filled]] connect form:
 
these will only result in a [[pre-filled]] connect form:
* server= (both server '''and''' channel must be provided!)
+
* server (both server '''and''' channel must be provided!)
* channel(you even can submit a comma separated channel list like %23chat,%23test)
+
* channel (you even can submit a comma separated channel list like %23chat,%23test)
* nick(if empty a random nick like "mib_3Zh5F4" will be presented)
+
* nick (if empty a random nick like "mib_3Zh5F4" will be presented)
 
example:
 
example:
 
  https://www.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat&nick=yourNickHere
 
  https://www.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat&nick=yourNickHere

Revision as of 18:49, 21 May 2009

API | URI Parameters | Auto Connect


You can control the look/behavior of mibbit by calling it with various parameters in the uri (like .../?param1=value1&param2=value2&..., see examples):

widget

  • authmethod (default: nickserv, alternatives: auth or pass)
  • autoConnect (true bypasses the nick prompt, see Autoconnect).
  • channel (default: %23chat, even a comma separated channel list like %23ch1,%23ch2%20key1,key2 is possible)
  • charset (default: UTF-8, see Character_Sets)
  • customloading ( e.g., maybe%20you%20need%20to%20close%20other%20Mibbit%20windows%20first...)
  • customprompt (e.g., Welcome%20To%20MyChat)
  • debug (default: false); true opens a Log-tab
  • nick (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit)
  • noServerMotd (default: false)
  • noServerNotices (default: false)
  • noServerTab (default: true)
  • promptChannelKey (true: prompt for a channel password, overrides autoConnect)
  • promptPass (true: ask for a password, see authmethod, overrides autoConnect)
  • server (default: irc.mibbit.net)
  • settings (id taken from a widget-manager-account: "My Prefs", see Skins)

examples (just right-click and open in a new window for testing):

http://widget.mibbit.com/?promptPass=true&settings=ccfb0b22251ba27444e43fa1b9997c6f
http://widget.mibbit.com/?channel=%23test&noServerTab=false&nick=MibWid%3F%3F%3F
http://widget.mibbit.com/?server=irc.freenode.net&channel=%23test
https://widget.mibbit.com/?channel=%23mibbit&autoConnect=true

You can use the Widget-manager to create/preview a skin and the URI creator to create an iframe code snippet.

main client

these will only result in a pre-filled connect form:

  • server (both server and channel must be provided!)
  • channel (you even can submit a comma separated channel list like %23chat,%23test)
  • nick (if empty a random nick like "mib_3Zh5F4" will be presented)

example:

https://www.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat&nick=yourNickHere

or (used for the Firefox IRC handler):

  • url=<urlencoded irc://server/#channel>

example:

https://www.mibbit.com/?url=irc%3A%2F%2Firc.freenode.net%2f%23defocus

other valid parameters:

  • debug=(default: false); true opens a Log-tab (/debug as command works as well)
  • rcharset=AUTO (undocumented, auto-detects utf8 and iso-8859-1)