event.js

CandyChats are not dead yet.

Authors

Copyright

© 2011 Amiado Group AG.  All rights reserved.

Summary
event.js
Candy.View.EventEmpty hooks to capture events and inject custom code.
Candy.View.Event.ChatChat-related events
Functions
onAdminMessageCalled when receiving admin messages
onDisconnectCalled when client disconnects
onAuthfailCalled when authentication fails
Candy.View.Event.RoomRoom-related events
Functions
onAddCalled when a new room gets added
onShowCalled when a room gets shown
onHideCalled when a room gets hidden
onSubjectChangeCalled when a subject of a room gets changed
onCloseCalled after a room has been left/closed
onPresenceChangeCalled when presence of user changes (kick, ban)
Candy.View.Event.RosterRoster-related events
Functions
onUpdateCalled after a user have been added to the roster
onContextMenuCalled when a user clicks on the action menu arrow.
afterContextMenuCalled when after a the context menu is rendered
Candy.View.Event.MessageMessage-related events
Functions
beforeShowCalled before a new message will be shown.
onShowCalled after a new message has been shown
beforeSendCalled before a message get sent

Candy.View.Event

Empty hooks to capture events and inject custom code.

Parameters

(Candy.View.Event) selfitself
(jQuery) $jQuery

Candy.View.Event.Chat

Chat-related events

Summary
Functions
onAdminMessageCalled when receiving admin messages
onDisconnectCalled when client disconnects
onAuthfailCalled when authentication fails

Functions

onAdminMessage

onAdminMessage: function(args)

Called when receiving admin messages

Parameters

(Object) args{subject, message}

onDisconnect

onDisconnect: function()

Called when client disconnects

onAuthfail

onAuthfail: function()

Called when authentication fails

Candy.View.Event.Room

Room-related events

Summary
Functions
onAddCalled when a new room gets added
onShowCalled when a room gets shown
onHideCalled when a room gets hidden
onSubjectChangeCalled when a subject of a room gets changed
onCloseCalled after a room has been left/closed
onPresenceChangeCalled when presence of user changes (kick, ban)

Functions

onAdd

onAdd: function(args)

Called when a new room gets added

Parameters

(Object) args{roomJid, type=chat|groupchat, element}

onShow

onShow: function(args)

Called when a room gets shown

Parameters

(Object) args{roomJid, element}

onHide

onHide: function(args)

Called when a room gets hidden

Parameters

(Object) args{roomJid, element}

onSubjectChange

onSubjectChange: function(args)

Called when a subject of a room gets changed

Parameters

(Object) args{roomJid, element, subject}

onClose

onClose: function(args)

Called after a room has been left/closed

Parameters

(Object) args{roomJid}

onPresenceChange

onPresenceChange: function(args)

Called when presence of user changes (kick, ban)

Parameters

(Object) args{roomJid, user, reason, type}

Candy.View.Event.Roster

Roster-related events

Summary
Functions
onUpdateCalled after a user have been added to the roster
onContextMenuCalled when a user clicks on the action menu arrow.
afterContextMenuCalled when after a the context menu is rendered

Functions

onUpdate

onUpdate: function(args)

Called after a user have been added to the roster

Parameters

(Object) args{roomJid, user, action, element}

onContextMenu

onContextMenu: function(args)

Called when a user clicks on the action menu arrow.  The return value is getting appended to the menulinks.

Parameters

(Object) args{roomJid, user}

Returns

(Object)containing menulinks

afterContextMenu

afterContextMenu: function(args)

Called when after a the context menu is rendered

Parameters

(Object) args{roomJid, element, user}

Candy.View.Event.Message

Message-related events

Summary
Functions
beforeShowCalled before a new message will be shown.
onShowCalled after a new message has been shown
beforeSendCalled before a message get sent

Functions

beforeShow

beforeShow: function(args)

Called before a new message will be shown.

Parameters

(Object) args{roomJid, nick, message}

Returns

(String) message

onShow

onShow: function(args)

Called after a new message has been shown

Parameters

(Object) args{roomJid, element, nick, message}

beforeSend

beforeSend: function(message)

Called before a message get sent

Parameters

(String) message

Returns

(String) message

onAdminMessage: function(args)
Called when receiving admin messages
onDisconnect: function()
Called when client disconnects
onAuthfail: function()
Called when authentication fails
onAdd: function(args)
Called when a new room gets added
onShow: function(args)
Called when a room gets shown
onHide: function(args)
Called when a room gets hidden
onSubjectChange: function(args)
Called when a subject of a room gets changed
onClose: function(args)
Called after a room has been left/closed
onPresenceChange: function(args)
Called when presence of user changes (kick, ban)
onUpdate: function(args)
Called after a user have been added to the roster
onContextMenu: function(args)
Called when a user clicks on the action menu arrow.
afterContextMenu: function(args)
Called when after a the context menu is rendered
beforeShow: function(args)
Called before a new message will be shown.
onShow: function(args)
Called after a new message has been shown
beforeSend: function(message)
Called before a message get sent
Close