Difference between revisions of "Uri parameters"

From Mibbit Wiki
Jump to: navigation, search
m
(new css parameter for the loading pages)
Line 5: Line 5:
 
* [[authmethod]] (default: nickserv, alternatives: auth or pass)
 
* [[authmethod]] (default: nickserv, alternatives: auth or pass)
 
* [[autoConnect]] (true bypasses the nick prompt '''if''' an op enabled it, '''use only after users indicated that they really want to chat''', e.g., if they clicked a link to get onto a chat page, see [[Autoconnect]], '''must''' read!).  
 
* [[autoConnect]] (true bypasses the nick prompt '''if''' an op enabled it, '''use only after users indicated that they really want to chat''', e.g., if they clicked a link to get onto a chat page, see [[Autoconnect]], '''must''' read!).  
* [[channel]] (%23yourChat, even a comma separated channel list like %23ch1,%23ch2%20key1,key2 is possible)
+
*[[channel]] (%23yourChat, even a comma separated channel list like %23ch1,%23ch2%20key1,key2 is possible)
* [[charset]] (default: UTF-8, see [[Character Sets]])
+
*[[charset]] (default: UTF-8, see [[Character Sets]])
* [[customloading]] ( e.g., maybe%20you%20need%20to%20close%20other%20Mibbit%20windows%20first...)
+
*[[customloading]] ( e.g., maybe%20you%20need%20to%20close%20other%20Mibbit%20windows%20first...)
* [[customprompt]] (e.g., Welcome%20To%20MyChat)
+
*[[customprompt]] (e.g., Welcome%20To%20MyChat)
* [[debug]] (default: false); true opens a Log-tab
+
*[[debug]] (default: false); true opens a Log-tab
* [[delay]] (default: 2 seconds after entering the page, if [[Autoconnect]] is on)
+
*[[delay]] (default: 2 seconds after entering the page, if [[Autoconnect]] is on)
* [[nick]] (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit)  
+
*[[nick]] (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit)  
* [[noServerNotices]] (default: false)
+
*[[noServerNotices]] (default: false)
* [[noServerTab]] (default: true)
+
*[[noServerTab]] (default: true)
* [[promptBackground]] (default: black, sets loading color; might take 'inherit' as a value, not sure)
+
*[[promptChannelKey]] (true: prompt for a channel password, overrides autoConnect)
* [[promptChannelKey]] (true: prompt for a channel password, overrides autoConnect)
+
*[[promptPass]] (true: prompt for a password, see authmethod, overrides autoConnect)
* [[promptPass]] (true: ask for a password, see authmethod, overrides autoConnect)
+
*[[server]] (default: irc.mibbit.net)
* [[server]] (default: irc.mibbit.net)
+
*[[settings]] (id taken from a [http://widget.mibbit.com/manager/ widget-manager-account]: last line in "Prefs", see [[Skins]])
* [[settings]] (id taken from a [http://widget.mibbit.com/manager/ widget-manager-account]: last line in "Prefs", see [[Skins]])
 
 
* [[showMotd]] (default: true - overrides Prefs > chat data > MOTD)
 
* [[showMotd]] (default: true - overrides Prefs > chat data > MOTD)
 +
New css features (loading screen):
 +
*PromptBackground (default: light gray, %23eee)
 +
*PromptColor (default: dark gray, %23222)
 +
*PromptImage (only for [[premium widget]]s)
 +
After choosing a nick:
 +
*WaitingBackground (defauilt: black, %23000)
 +
*WaitingColor (default: light gray, %23ccc)
 +
*WaitingImage (only for [[premium widget]]s)
 +
  
 
examples (just right-click and open in a new window for testing):
 
examples (just right-click and open in a new window for testing):
Line 50: Line 58:
 
  http://mibbit.com/#javascript@irc.ircstorm.net
 
  http://mibbit.com/#javascript@irc.ircstorm.net
 
  http://mibbit.com/#coolChannel@IRCStorm
 
  http://mibbit.com/#coolChannel@IRCStorm
 +
http://miburl.com/wGcgqD (new css parameter example for the loading pages)
 
or (used for the Firefox [[Irc: urls in Mozilla|IRC handler]]):
 
or (used for the Firefox [[Irc: urls in Mozilla|IRC handler]]):
 
* <nowiki>url=<urlencoded irc://server/#channel></nowiki>
 
* <nowiki>url=<urlencoded irc://server/#channel></nowiki>

Revision as of 11:58, 12 February 2010

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 if an op enabled it, use only after users indicated that they really want to chat, e.g., if they clicked a link to get onto a chat page, see Autoconnect, must read!).
  • channel (%23yourChat, 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
  • delay (default: 2 seconds after entering the page, if Autoconnect is on)
  • nick (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit)
  • noServerNotices (default: false)
  • noServerTab (default: true)
  • promptChannelKey (true: prompt for a channel password, overrides autoConnect)
  • promptPass (true: prompt for a password, see authmethod, overrides autoConnect)
  • server (default: irc.mibbit.net)
  • settings (id taken from a widget-manager-account: last line in "Prefs", see Skins)
  • showMotd (default: true - overrides Prefs > chat data > MOTD)

New css features (loading screen):

  • PromptBackground (default: light gray, %23eee)
  • PromptColor (default: dark gray, %23222)
  • PromptImage (only for premium widgets)

After choosing a nick:

  • WaitingBackground (defauilt: black, %23000)
  • WaitingColor (default: light gray, %23ccc)
  • WaitingImage (only for premium widgets)


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=0&nick=MibWid%3F%3F%3F
http://widget.mibbit.com/?server=irc.rizon.net&channel=%23test
https://widget.mibbit.com/?channel=%23yourCh&autoConnect=true

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

other valid entries:

  • 0 / 1 are also allowed for false / true

main client

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

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

alternatively you can use:

  • mibbit.com/chat/#channel (defaults to: @irc.mibbit.net)
  • mibbit.com/#channel@your.server.blah
  • mibbit.com/#channel@Network (as saved in our database)

Note: this doesn't work on some pages like twitter.com

Examples:

http://mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere
https://www.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat
http://www.mibbit.com/chat/#help
http://mibbit.com/#javascript@irc.ircstorm.net
http://mibbit.com/#coolChannel@IRCStorm
http://miburl.com/wGcgqD (new css parameter example for the loading pages)

or (used for the Firefox IRC handler):

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

example:

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

Note: this will not work if networks allow mibbit only on certain servers/ports, e.g., EFnet: irc.umich.edu

other valid parameters:

  • debug=(default: false); true opens a Log-tab (/debug as command works as well)