Jabber: Difference between revisions

Latest revision as of 04:44, 25 August 2015

This service is mainly a simple notification and AniDB pm forward function implemented into Jabber. This way you don't need to run additional software if you are already running a multi-network Instant Messenger (Trillian, Miranda, Pidgin, ...) or a standalone Jabber client.

More about Jabber: Wikipedia Jabber Entry

Features

Specifically it allows you to:

get your AniDB pm in real time
get your AniDB notifications in real time
send AniDB pm via Jabber
request fileinfo

Usage

get a Jabber client. (recommended is miranda, as it's a lightweight multinetwork client)
get a Jabber account
enter your Jabberaccount in _lower case_ in your profile in AniDB
- Profile Settings > Notifications tab > Jabber Instant Message Service
add anidb@im.anidb.net as one of your contacts
open a chatsession with it and type

subscribe <AniDB username> <AniDB password>

(without the <> of course)

Usage within GMail

Since Google Talk is basically a Jabber client, and GMail provides a "chat" component that interfaces with it, you can use it to access the AniDB Jabber Server from GMail.

enter your Jabberaccount in _lower case_ in your profile in AniDB
- Profile Settings > Notifications tab > Jabber Instant Message Service
Open your GMail account on the browser.
click on "Add Contact" (located on your Quick Contacts bar on the left side).
enter anidb@im.anidb.net and click on "Send Invites".
open a chatsession with it and type

subscribe <AniDB username> <AniDB password>

(without the <> of course)

Note	This method will try to send an email invitation to the AniDB Jabber Server. You'll receive one email with a delivery error message, which can be ignored with no ill effects.

General Information

To minimize the server load the AniDB Jabber Server will only send notifications and messages to users who are subscribed AND online. However, the AniDB Jabber Server will only be able to tell whether you are online or not, if you permit it to add you to it's contact list. You can check your current status with the status command. If your status is not listed as ONLINE, you will not receive any notifications/messages. If your status won't change to ONLINE but is stuck at INACTIVE, check if you have entered your Jabber ID in lower case only (in your profile on the AniDB site and in your Jabber client).

You can use the reactivate command to tell the AniDB Jabber Server to re-add you to it's contact list, should you for some reason have failed to grant it's first attempt.

Note that all actions are handed in batch jobs which can lead to a delay of one to five minutes, depending on the action. (i.e. your online status will not be updated in real time)

Commands

help

Displays a list with all commands

file

file <fid>

Displays details for the file.

msg

msg <username> <message>

Sends an AniDB message to a user.

msgread

Marks the latest unread message as read. Please note that this might be a different message than the last one you received via Jabber.

msgreadall

Marks all unread messages as read.

msglist

Returns titles and senders for the latest five messages.

subscribe

subscribe <AniDB username> <AniDB password>

Enables you to receive AniDB Notify/PM messages in real time.

unsubscribe

Disables AniDB Notify/PM messages.

reactivate

Reactivates your subscription after suspension.

Currently this is only useful if you have failed to grant the attempt of the AniDB Jabber Server to add you to it's contact list.

status

Displays your current subscription status.

The online status is especially important. You will not receive any notifications/messages if your status is not ONLINE. Take note that the status is not updated in real time. You should wait for about five minutes for it to update when you come online.

version

Displays the current version of the service.

plugins

Displays the currently loaded plugins and their versions.

Future

Will we add more features/commands?

Maybe, that depends on the demand. We might add support for most of Chii[AR]'s commands someday if there is enough interest among the AniDB userbase.

@@ Line 1: / Line 1: @@
 {{TOCright}}
-This service is mainly a simple [[Notifications|notification]] and anidb pm forward function implemented into jabber. This way you don't need to run additional software if you are already running a multinetwork Instant Messanger ([http://www.ceruleanstudios.com/ Trillian], [http://www.miranda-im.org/ Miranda], [http://gaim.sourceforge.net/ Gaim], ...) or a standalone jabber client.
+This service is mainly a simple [[Notifications|notification]] and AniDB pm forward function implemented into Jabber. This way you don't need to run additional software if you are already running a multi-network Instant Messenger ([http://www.ceruleanstudios.com/ Trillian], [http://www.miranda-im.org/ Miranda], [http://www.pidgin.im Pidgin], ...) or a standalone Jabber client.
-More about jabber: [http://en.wikipedia.org/wiki/Jabber Wikipedia Jabber Entry]
+More about Jabber: [[Wikipedia:Jabber|Wikipedia Jabber Entry]]
 ===Features===
 Specifically it allows you to:
-*get your anidb pm in realtime
+*get your AniDB pm in real time
-*get your anidb notifications in realtime
+*get your AniDB notifications in real time
-*send anidb pm via jabber
+*send AniDB pm via Jabber
 *request fileinfo
 ===Usage===
+#get a Jabber client. (recommended is miranda, as it's a lightweight multinetwork client)
-#get a jabber client. (recommended is miranda, as it's a lightweight multinetwork client)
+#[http://www.jabber.org/web/Quickstart get a Jabber account]
-#[http://www.jabber.org/user/userguide/#register get a jabber account]
+#enter your Jabberaccount in _lower case_ in your profile in AniDB
-#add <b>anidb@im.anidb.info</b> as one of your contacts
+#* <tt>Profile Settings > Notifications tab > Jabber Instant Message Service</tt>
+#add '''anidb@im.anidb.net''' as one of your contacts
 #open a chatsession with it and type
-::<tt>subscribe <anidb username> <anidb password></tt>
+::<tt>subscribe <AniDB username> <AniDB password></tt>
-::<i>(without the <> of course)</i>
+::''(without the <> of course)''
 ===Usage within GMail===
 Since Google Talk is basically a Jabber client, and GMail provides a "chat" component that interfaces with it, you can use it to access the AniDB Jabber Server from GMail.
+#enter your Jabberaccount in _lower case_ in your profile in AniDB
+#* <tt>Profile Settings > Notifications tab > Jabber Instant Message Service</tt>
 #Open your [http://www.gmail.com GMail] account on the browser.
 #click on "Add Contact" (located on your Quick Contacts bar on the left side).
-#enter <b>anidb@im.anidb.info</b> and click on "Send Invites".
+#enter '''anidb@im.anidb.net''' and click on "Send Invites".
 #open a chatsession with it and type
-::<tt>subscribe <anidb username> <anidb password></tt>
+::<tt>subscribe <AniDB username> <AniDB password></tt>
-::<i>(without the <> of course)</i>
+::''(without the <> of course)''
-<b>Note:</b> this method will try to send an email invitation to the AniDB Jabber Server. You'll receive one email with a delivery error message, which can be ignored with no ill effects.
+{{eyecatch|Note|This method will try to send an email invitation to the AniDB Jabber Server. You'll receive one email with a delivery error message, which can be ignored with no ill effects.}}
 ===General Information===
-To minimize the server load the AniDB Jabber Server will only send notifications and messages to users who are subscribed <b>AND</b> online. However, the AniDB Jabber Server will only be able to tell whether you are online or not, if you permit it to add you to it's contact list. You can check your current status with the <b>status</b> command. If your status is not listed as <b>ONLINE</b>, you will not receive any notifications/messages.
+To minimize the server load the AniDB Jabber Server will only send notifications and messages to users who are subscribed '''AND''' online. However, the AniDB Jabber Server will only be able to tell whether you are online or not, if you permit it to add you to it's contact list. You can check your current status with the '''status''' command. If your status is not listed as '''ONLINE''', you will not receive any notifications/messages. If your status won't change to '''ONLINE''' but is stuck at '''INACTIVE''', check if you have entered your Jabber ID in <u>lower case only</u> (in your profile on the AniDB site and in your Jabber client).
-You can use the <b>reactivate</b> command to tell the AniDB Jabber Server to re-add you to it's contact list, should you for some reason have failed to grant it's first attempt.
+You can use the '''reactivate''' command to tell the AniDB Jabber Server to re-add you to it's contact list, should you for some reason have failed to grant it's first attempt.
-Note that all actions are handed in batch jobs which can lead to a delay of one to five minutes, depending on the action. <i>(i.e. your online status will not be updated in realtime)</i>
+Note that all actions are handed in batch jobs which can lead to a delay of one to five minutes, depending on the action. ''(i.e. your online status will not be updated in real time)''
 ==Commands==
@@ Line 46: / Line 49: @@
 ===file===
-file <fid>
+ file <fid>
 Displays details for the file.
 ===msg===
-msg <username> <message>
+ msg <username> <message>
 Sends an AniDB message to a user.
+===msgread===
+Marks the latest unread message as read. Please note that this might be a different message than the last one you received via Jabber.
+===msgreadall===
+Marks all unread messages as read.
+===msglist===
+Returns titles and senders for the latest five messages.
 ===subscribe===
-subscribe <anidb username> <anidb password>
+ subscribe <AniDB username> <AniDB password>
 Enables you to receive AniDB Notify/PM messages in real time.
@@ Line 66: / Line 78: @@
 Reactivates your subscription after suspension.
-Currently this is only usefull if you have failed to grant the attempt of the AniDB Jabber Server to add you to it's contact list.
+Currently this is only useful if you have failed to grant the attempt of the AniDB Jabber Server to add you to it's contact list.
 ===status===
 Displays your current subscription status.
-The online status is especially important. You will not receive any notifications/messages if your status is not <b>ONLINE</b>.
+The online status is especially important. You will not receive any notifications/messages if your status is not '''ONLINE'''.
 Take note that the status is not updated in real time. You should wait for about five minutes for it to update when you come online.
 ===version===
-displays the current version of the service
+Displays the current version of the service.
+===plugins===
+Displays the currently loaded plugins and their versions.
 ==Future==
@@ Line 83: / Line 97: @@
 Maybe, that depends on the demand. We might add support for most of Chii[AR]'s commands someday if there is enough interest among the AniDB userbase.
+[[Category:Features]]