Difference between revisions of "Uri parameters"

From Mibbit Wiki
Jump to: navigation, search
(promptBackground)
m (Main Client: be aware of autoconnect)
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{articles}}
 
{{widget}}
 
{{widget}}
  
 
You can control the look/behavior of mibbit by calling it with various parameters in the uri (like .../?param1=value1&param2=value2&..., see examples):
 
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)
+
{{notice|don't use "&" instead of "&". It is not valid for uri parameters and might stop working in the future.}}
* 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)
+
*[[authmethod]] (default: nickserv, alternatives: auth or pass)
* charset (default: UTF-8, see [[Character Sets]])
+
*[[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!).  
* customloading ( e.g., maybe%20you%20need%20to%20close%20other%20Mibbit%20windows%20first...)
+
*[[channel]] (%23yourChat, even a comma separated channel list like %23ch1,%23ch2%20key1,key2 is possible)
* customprompt (e.g., Welcome%20To%20MyChat)
+
*[[charset]] (default: UTF-8, see [[Character Sets]])
* debug (default: false); true opens a Log-tab
+
*[[Userlist color|ciUserListColorNormal=true]]
* delay (default: 2 seconds after entering the page, if [[Autoconnect]] is on)
+
*[[Userlist color|csUserListColorNormal=%23<hex color>]]
* nick (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit)  
+
*[[customloading]] ( e.g., maybe%20you%20need%20to%20close%20other%20Mibbit%20windows%20first...)
* noServerNotices (default: false)
+
*[[customprompt]] (e.g., Welcome%20To%20MyChat)
* noServerTab (default: true)
+
*[[debug]] (default: false); true opens a Log-tab
* promptBackground (default: black, sets loading color; might take 'inherit' as a value, not sure)
+
*[[disableWS]] (default: false); if you notice websocket issues try "true" for debugging
* promptChannelKey (true: prompt for a channel password, overrides autoConnect)
+
*[[delay]] (default: 2 seconds after entering the page, if [[Autoconnect]] is on)
* promptPass (true: ask for a password, see authmethod, overrides autoConnect)
+
*[[nick]] (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit)  
* server (default: irc.mibbit.net)
+
*[[noServerNotices]] (default: false)
* settings (id taken from a [http://widget.mibbit.com/manager/ widget-manager-account]: last line in "Prefs", see [[Skins]])
+
*[[noServerTab]] (default: true)
* showMotd (default: true - overrides Prefs > chat data > MOTD)
+
*PromptImage (only for [[premium widget]]s)
 +
*[[promptChannelKey]] (true: prompt for a channel password, 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)
 +
*[[skins|settings]] (id taken from a [https://widgetmanager.mibbit.com/index.php?view=graphs])
 +
*[[MOTD|showMotd]] (default: true - overrides Prefs > chat data > MOTD)
 +
*WaitingImage (only for [[premium widget]]s)
 +
 
 +
the following options don't seem to work any longer:
 +
 
 +
*PromptBackground (default: light gray, %23eee)
 +
*PromptColor (default: dark gray, %23222)
 +
*WaitingBackground (defauilt: black, %23000)
 +
*WaitingColor (default: light gray, %23ccc)
  
 
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 27: Line 41:
 
  https://widget.mibbit.com/?channel=%23yourCh&autoConnect=true
 
  https://widget.mibbit.com/?channel=%23yourCh&autoConnect=true
  
You can use the [http://widget.mibbit.com/manager/ Widget-manager] to create/preview a skin and the [http://irc.us.mibbit.net/widget-uri-creator/ URI creator] to create an iframe code snippet.
+
Please use the [http://widgetmanager.mibbit.com/ Widget-manager] to create a skin and an iframe code snippet.
  
 
other valid entries:
 
other valid entries:
 
* 0 / 1 are also allowed for false / true
 
* 0 / 1 are also allowed for false / true
  
==main client==
+
==Main Client==
these will only result in a [[pre-filled]] connect form:
+
 
* nick (if empty a random nick like "mib_3Zh5F4" will be presented)
+
{{notice|In old links/bookmarks please replace "'''www.'''mibbit.com/'''chat'''" or "mibbit.com/'''chat'''" respectively with "'''chat.'''mibbit.com".}}
* 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 (default: @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
+
Passing parameters will result in a [[pre-filled]] connect form (if not connected already to the network via [[autoconnect]] etc):
 +
* [[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!)
  
 
Examples:
 
Examples:
  http://mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere
+
  http://chat.mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere
  https://www.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat
+
  https://chat.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
 
 
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>
 
example:  
 
example:  
  https://www.mibbit.com/?url=irc%3A%2F%2Firc.ircstorm.net%2f%23lobby
+
  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
 
'''Note:''' this will '''not''' work if networks allow mibbit only on certain servers/ports, e.g., EFnet: irc.umich.edu
  
 
other valid parameters:
 
other valid parameters:
* debug=(default: false); true 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)
  
 
[[Category:Features]]
 
[[Category:Features]]
 
[[Category:Widget]]
 
[[Category:Widget]]
 +
[[Category:Uri parameters]]
 
{{DEFAULTSORT:Uri Parameters}}
 
{{DEFAULTSORT:Uri Parameters}}

Revision as of 15:34, 12 December 2013

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 | 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.

the following options don't seem to work any longer:

  • PromptBackground (default: light gray, %23eee)
  • PromptColor (default: dark gray, %23222)
  • WaitingBackground (defauilt: black, %23000)
  • WaitingColor (default: light gray, %23ccc)

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

Please use the Widget-manager to create a skin and 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 (if not connected already to the network via autoconnect etc):

  • 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!)

Examples:

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

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)