Difference between revisions of "Uri parameters"

From Mibbit Wiki
Jump to: navigation, search
m
(tony changed widgetmanager)
Line 26: Line 26:
 
*[[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)
*[[skins|settings]] (id taken from a [http://widget.mibbit.com/manager/ widget-manager-account]: last line in "Prefs")
+
*[[skins|settings]] (id taken from a [https://widgetmanager.mibbit.com/index.php?view=graphs])
 
*[[MOTD|showMotd]] (default: true - overrides Prefs > chat data > MOTD)
 
*[[MOTD|showMotd]] (default: true - overrides Prefs > chat data > MOTD)
 
*WaitingBackground (defauilt: black, %23000)
 
*WaitingBackground (defauilt: black, %23000)

Revision as of 22:04, 7 May 2012

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 "&" instead of "&". It is not valid for uri parameters and might stop working in the future.
  • 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)
  • ciUserListColorNormal=true
  • csUserListColorNormal=%23<hex color>
  • 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
  • disableWS (default: false); if you notice websocket issues try "true" for debugging
  • 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)
  • PromptBackground (default: light gray, %23eee)
  • PromptColor (default: dark gray, %23222)
  • PromptImage (only for premium widgets)
  • 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)
  • settings (id taken from a [1])
  • showMotd (default: true - overrides Prefs > chat data > MOTD)
  • 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
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.rizon.net

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)