Difference between revisions of "Uri parameters"
(→widget: Autoconnect]], MUST read!) |
m (→Widget: +%3A%2B6697 example) |
||
(57 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¶m2=value2&..., see examples): | You can control the look/behavior of mibbit by calling it with various parameters in the uri (like .../?param1=value1¶m2=value2&..., see examples): | ||
− | == | + | ==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, '''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]], | + | |
− | * 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 |
− | * promptChannelKey (true: prompt for a channel password, overrides autoConnect) | + | *[[disableWS]] (default: false); if you notice websocket issues try "true" for debugging |
− | * promptPass (true: | + | *[[delay]] (default: 2 seconds after entering the page, if [[Autoconnect]] is on) |
− | * server (default: irc.mibbit.net) | + | *[[nick]] (e.g., prefix_%3F%3F%3F%3F , %3F=? representing a random digit) |
− | * settings (id taken from a [ | + | *[[noServerNotices]] (default: false) |
− | + | *[[noServerTab]] (default: true) | |
+ | *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): | ||
− | + | https://widget.mibbit.com/?promptPass=true&settings=ccfb0b22251ba27444e43fa1b9997c6f | |
− | + | https://widget.mibbit.com/?channel=%23test&noServerTab=0&nick=MibWid%3F%3F%3F | |
− | + | https://widget.mibbit.com/?server=irc.rizon.net%3A%2B6697&channel=%23Mibbit | |
− | https://widget.mibbit.com/?channel=% | + | https://widget.mibbit.com/?channel=%23yourCh&autoConnect=true |
− | + | Please use the [https://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== |
− | + | ||
− | + | {{notice|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: | Examples: | ||
− | + | https://chat.mibbit.com/?server=irc.blah.net&channel=%23theChannel&nick=yourNickHere | |
− | https:// | + | https://chat.mibbit.com/?server=irc.mibbit.net&channel=%23mibbit,%23chat |
− | |||
− | |||
− | |||
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:// | + | 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= | + | * [[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}} |
Latest revision as of 12:39, 20 April 2020
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
You can control the look/behavior of mibbit by calling it with various parameters in the uri (like .../?param1=value1¶m2=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)
- 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)
- WaitingImage (only for premium widgets)
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):
https://widget.mibbit.com/?promptPass=true&settings=ccfb0b22251ba27444e43fa1b9997c6f https://widget.mibbit.com/?channel=%23test&noServerTab=0&nick=MibWid%3F%3F%3F https://widget.mibbit.com/?server=irc.rizon.net%3A%2B6697&channel=%23Mibbit 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:
https://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)