action.js

Candy

Chats are not dead yet.

Authors

Patrick Stadler patrick.nosp@m..stadler@gmai.nosp@m.l.com
Michael Weibel michael.nosp@m..weibel@gmai.nosp@m.l.com

Copyright

Summary

action.js
Candy.Core.Action	Chat Actions (basicly a abstraction of Jabber commands)
Candy.Core.Action.Jabber	Jabber actions
Functions
Version	Replies to a version request
Roster	Sends a request for a roster
Presence	Sends a request for presence
Services	Sends a request for disco items
Autojoin	When Candy.Core.getOptions().autojoin is true, request autojoin bookmarks (OpenFire)
ResetIgnoreList	Create new ignore privacy list (and reset the old one, if it exists).
RemoveIgnoreList	Remove an existing ignore list.
GetIgnoreList	Get existing ignore privacy list when connecting.
SetIgnoreListActive	Set ignore privacy list active
GetJidIfAnonymous	On anonymous login, initially we don’t know the jid and as a result, Candy.Core._user doesn’t have a jid.
Candy.Core.Action.Jabber.Room	Room-specific commands
Functions
Join	Requests disco of specified room and joins afterwards.
Leave	Leaves a room.
Disco	Requests disco info of a room.
Message	Send message
IgnoreUnignore	Checks if the user is already ignoring the target user, if yes: unignore him, if no: ignore him.
UpdatePrivacyList	Updates privacy list according to the privacylist in the currentUser
Candy.Core.Action.Jabber.Room.Admin	Room administration commands
Functions
UserAction	Kick or ban a user
SetSubject	Sets subject (topic) of a room.

Candy.Core.Action

Chat Actions (basicly a abstraction of Jabber commands)

Parameters

(Candy.Core.Action) self	itself
(Strophe) Strophe	Strophe
(jQuery) $	jQuery

Candy.Core.Action.Jabber

Jabber actions

Summary

Functions
Version	Replies to a version request
Roster	Sends a request for a roster
Presence	Sends a request for presence
Services	Sends a request for disco items
Autojoin	When Candy.Core.getOptions().autojoin is true, request autojoin bookmarks (OpenFire)
ResetIgnoreList	Create new ignore privacy list (and reset the old one, if it exists).
RemoveIgnoreList	Remove an existing ignore list.
GetIgnoreList	Get existing ignore privacy list when connecting.
SetIgnoreListActive	Set ignore privacy list active
GetJidIfAnonymous	On anonymous login, initially we don’t know the jid and as a result, Candy.Core._user doesn’t have a jid.

Functions

Version

Version: function( msg )

Replies to a version request

Parameters

(jQuery.element) msg

jQuery element

Roster

Roster: function()

Sends a request for a roster

Presence

Presence: function( attr )

Sends a request for presence

Parameters

(Object) attr

Optional attributes

Services

Services: function()

Sends a request for disco items

Autojoin

Autojoin: function()

When Candy.Core.getOptions().autojoin is true, request autojoin bookmarks (OpenFire)

Otherwise, if Candy.Core.getOptions().autojoin is an array, join each channel specified.

ResetIgnoreList

ResetIgnoreList: function()

Create new ignore privacy list (and reset the old one, if it exists).

RemoveIgnoreList

RemoveIgnoreList: function()

Remove an existing ignore list.

GetIgnoreList

GetIgnoreList: function()

Get existing ignore privacy list when connecting.

SetIgnoreListActive

SetIgnoreListActive: function()

Set ignore privacy list active

GetJidIfAnonymous

GetJidIfAnonymous: function()

On anonymous login, initially we don’t know the jid and as a result, Candy.Core._user doesn’t have a jid. Check if user doesn’t have a jid and get it if necessary from the connection.

Candy.Core.Action.Jabber.Room

Room-specific commands

Summary

Functions
Join	Requests disco of specified room and joins afterwards.
Leave	Leaves a room.
Disco	Requests disco info of a room.
Message	Send message
IgnoreUnignore	Checks if the user is already ignoring the target user, if yes: unignore him, if no: ignore him.
UpdatePrivacyList	Updates privacy list according to the privacylist in the currentUser

Functions

Join

Join: function( roomJid,
password )

Requests disco of specified room and joins afterwards.

TODO

maybe we should wait for disco and later join the room? but what if we send disco but don’t want/can join the room

Parameters

(String) roomJid	Room to join
(String) password	[optional] Password for the room

Leave

Leave: function( roomJid )

Leaves a room.

Parameters

(String) roomJid

Room to leave

Disco

Disco: function( roomJid )

Requests disco info of a room.

Parameters

(String) roomJid

Room to get info for

Message

Message: function( roomJid,
msg,
type )

Send message

Parameters

(String) roomJid	Room to which send the message into
(String) msg	Message
(String) type	”groupchat” or “chat” (“chat” is for private messages)

Returns

(Boolean)

true if message is not empty after trimming, false otherwise.

IgnoreUnignore

IgnoreUnignore: function( userJid )

Checks if the user is already ignoring the target user, if yes: unignore him, if no: ignore him.

Uses the ignore privacy list set on connecting.

Parameters

(String) userJid

Target user jid

UpdatePrivacyList

UpdatePrivacyList: function()

Updates privacy list according to the privacylist in the currentUser

Candy.Core.Action.Jabber.Room.Admin

Room administration commands

Summary

Functions
UserAction	Kick or ban a user
SetSubject	Sets subject (topic) of a room.

Functions

UserAction

UserAction: function( roomJid,
userJid,
type,
reason )

Kick or ban a user

Parameters

(String) roomJid	Room in which the kick/ban should be done
(String) userJid	Victim
(String) type	”kick” or “ban”
(String) msg	Reason

Returns

(Boolean)

true if sent successfully, false if type is not one of “kick” or “ban”.

SetSubject

SetSubject: function( roomJid,
subject )

Sets subject (topic) of a room.

Parameters

(String) roomJid	Room
(String) subject	Subject to set