Difference between revisions of "Uri parameters"

From Mibbit Wiki
Jump to: navigation, search
m (Main Client)
m (Reverted edits by Hercule (talk) to last revision by Havvy)
Line 12: Line 12:
 
*[[Userlist color|ciUserListColorNormal=true]]
 
*[[Userlist color|ciUserListColorNormal=true]]
 
*[[Userlist color|csUserListColorNormal=%23<hex color>]]
 
*[[Userlist color|csUserListColorNormal=%23<hex color>]]
*[[customloading]] (overrides settings in Preferences -> Widget)
+
*[[Twitter|colorTwitterUser]]
*[[customprompt]] (overrides settings in Preferences -> Widget, e.g., Welcome%20To%20MyChat)
+
*[[customloading]] ( e.g., maybe%20you%20need%20to%20close%20other%20Mibbit%20windows%20first...)
 +
*[[customprompt]] (e.g., Welcome%20To%20MyChat)
 +
*[[Twitter|hashtag]] (e.g. twitterTrendingTopicHashtag)
 
*[[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)
Line 19: Line 21:
 
*[[noServerNotices]] (default: false)
 
*[[noServerNotices]] (default: false)
 
*[[noServerTab]] (default: true)
 
*[[noServerTab]] (default: true)
*parseMOTDChannels (default: false); true forces links in the MOTD being clickable
+
*PromptBackground (default: light gray, %23eee)
*PromptBackground (overrides settings in Preferences -> Widget, default: light gray, %23eee)
+
*PromptColor (default: dark gray, %23222)
*PromptColor (overrides settings in Preferences -> Widget, default: dark gray, %23222)
+
*PromptImage (only for [[premium widget]]s)
*PromptImage (overrides settings in Preferences -> Widget, only for [[premium widget]]s)
+
 
*[[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: prompt for a password, see authmethod, overrides autoConnect)
 
*[[server]] (default: irc.mibbit.net ; e.g., ssl: irc.mibbit.net%3A%2B6697)
 
*[[server]] (default: irc.mibbit.net ; e.g., ssl: irc.mibbit.net%3A%2B6697)
*[[sessionTimeout]] (default: 30; number of seconds to timeout session, or 0 to disable altogether; 30 is the maximum)
+
*[[skins|settings]] (id taken from a [http://widget.mibbit.com/manager/ widget-manager-account]: last line in "Prefs")
*[[skins|settings]] (ID as displayed on [http://WidgetManager.Mibbit.com/ widget-manager-account] -> "Usage graphs")
+
 
*[[MOTD|showMotd]] (default: true - overrides Prefs > chat data > MOTD)
 
*[[MOTD|showMotd]] (default: true - overrides Prefs > chat data > MOTD)
*WaitingBackground (overrides settings in Preferences -> Widget, defauilt: black, %23000)
+
*WaitingBackground (defauilt: black, %23000)
*WaitingColor (overrides settings in Preferences -> Widget, default: light gray, %23ccc)
+
*WaitingColor (default: light gray, %23ccc)
*WaitingImage (overrides settings in Preferences -> Widget, only for [[premium widget]]s)
+
*WaitingImage (only for [[premium widget]]s)
  
  
Line 41: Line 41:
 
  http://miburl.com/wGcgqD (new css parameter example for the start screens)
 
  http://miburl.com/wGcgqD (new css parameter example for the start screens)
  
You can use the [http://WidgetManager.Mibbit.com/ Widget-manager] to create/preview a skin and the [http://tools.mibbit.com/widget-uri-creator/ URI creator] to create an iframe code snippet.
+
You can use the [http://widget.mibbit.com/manager/ Widget-manager] to create/preview a skin and the [http://tools.mibbit.com/widget-uri-creator/ URI creator] to create an iframe code snippet.
  
 
other valid entries:
 
other valid entries:
Line 56: Line 56:
  
 
alternatively you can use:
 
alternatively you can use:
* mibbit.com/#channel (defaults to: @irc.mibbit.net, chat.mibbit.com/#channel doesn't work at the moment)
+
* chat.mibbit.com/#channel (defaults to: @irc.mibbit.net)
 +
* chat.mibbit.com/#channel@your.server.blah
 +
* chat.mibbit.com/#channel@Network (as saved in our database)
  
 
'''Note''': this works only if no autoconnects are enabled and doesn't work on some pages like twitter.com
 
'''Note''': this works only if no autoconnects are enabled and doesn't work on some pages like twitter.com
Line 62: Line 64:
 
Examples:
 
Examples:
 
  http://chat.mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere
 
  http://chat.mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere
  https://mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat
+
  https://chat.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat
  http://mibbit.com/#help
+
  http://chat.mibbit.com/#help
 +
http://chat.mibbit.com/#javascript@irc.ircstorm.net
 +
http://chat.mibbit.com/#coolChannel@IRCStorm
 
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>
Line 72: Line 76:
 
other valid parameters:
 
other valid parameters:
 
* [[debug]]=<anything> opens a Log-tab (/debug as command works as well)
 
* [[debug]]=<anything> opens a Log-tab (/debug as command works as well)
* noWebSocket=true forces the browser '''not''' to use a [[websocket]] to circumvent instabilities; default is false)
+
* noWebSocket=true forces the browser '''not''' to use a websocket to circumvent instabilities; default is false)
  
 
[[Category:Features]]
 
[[Category:Features]]

Revision as of 19:21, 16 May 2011

Wiki Home | FAQ | Features | IRC Commands | IRC Modes | Widget Information | Widget: WebIRC Server Setup | URI Parameters | Wish List | Registration Information | Mibbit Staff

Home | Quick Start Guide | Blog & News | Live Mibbit Help


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

don't use "&amp;" instead of "&". It is not valid for uri parameters and might stop working in the future.


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
http://miburl.com/wGcgqD (new css parameter example for the start screens)

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

In old links/bookmarks please replace "www.mibbit.com/chat" or "mibbit.com/chat" respectively with "chat.mibbit.com".

Passing parameters will 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:

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

Note: this works only if no autoconnects are enabled and doesn't work on some pages like twitter.com

Examples:

http://chat.mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere
https://chat.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat
http://chat.mibbit.com/#help
http://chat.mibbit.com/#javascript@irc.ircstorm.net
http://chat.mibbit.com/#coolChannel@IRCStorm

or (used for the Firefox IRC handler):

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

example:

https://chat.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=<anything> opens a Log-tab (/debug as command works as well)
  • noWebSocket=true forces the browser not to use a websocket to circumvent instabilities; default is false)