Class Index | File Index

Classes


Class Event.XMPPEvent

XMPP Event representation
Defined in: <D:\Programs\Neeve\Projects\NeeveBuild\stjsapi/src/main/webapp/js\event\XMPPEvent.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Event.XMPPEvent(eventId)
Creates a new XMPP event
Method Summary
Method Attributes Method Name and Description
void 
Returns the xmpp message body.
void 
Returns the xmpp message body.
void 
Returns the xmpp error text or null if no error occurred.
void 
Returns the xmpp error code or -1 if no error occurred.
void 
Returns the jabber id of the event sender.
void 
Returns the id of the event xmpp-stanza.
void 
Returns the xmpp message priority or -1 if the message type is not.
void 
Returns the show-property of xmpp presence stanza.
void 
Returns the status for xmpp presence stanza.
void 
Returns the xmpp message thread.
void 
Returns the jabber id of the event recipient.
void 
Returns the type of the event xmpp-stanza.
void 
setBody(body)
Sets the xmpp message body.
void 
setData(data)
Sets the xmpp message body.
void 
setError(error)
Sets the xmpp error text.
void 
setErrorCode(errorCode)
Sets the xmpp error code.
void 
setFrom(from)
Sets the jabber id of the event sender.
void 
setId(id)
Sets the id of the event xmpp-stanza.
void 
setPriority(priority)
Sets the xmpp message priority.
void 
setShow(show)
Sets the show-property of xmpp presence stanza.
void 
setStatus(status)
Sets the status for xmpp presence stanza.
void 
setSubject(subject)
Sets the xmpp message subject.
void 
setThread(thread)
Sets the xmpp message thread.
void 
setTo(to)
Sets the jabber id of the event recipient.
void 
setType(type)
Sets the type of the event xmpp-stanza.
Class Detail
Event.XMPPEvent(eventId)
Creates a new XMPP event
Parameters:
{String} eventId
The id of the XML event to be created
Method Detail
getBody()
Returns the xmpp message body.
Returns:
the body of the xmpp message.

getData()
Returns the xmpp message body.
Returns:
the body of the xmpp message.

getError()
Returns the xmpp error text or null if no error occurred.
Returns:
the xmpp error text or null.

getErrorCode()
Returns the xmpp error code or -1 if no error occurred.
Returns:
the xmpp error code or -1.

getFrom()
Returns the jabber id of the event sender.
Returns:
the sender jabber id.

getId()
Returns the id of the event xmpp-stanza.
Returns:
the xmpp-stanza id.

getPriority()
Returns the xmpp message priority or -1 if the message type is not. See XMPPEvent#EVENT_ID_PRESENCE
Returns:
the xmpp message priority or -1.

getShow()
Returns the show-property of xmpp presence stanza. This property contains additional information about an xmpp user status. The possible values are: 'away', 'chat', 'dnd', 'xa'.
Returns:
the show-property of xmpp presence stanza.

getStatus()
Returns the status for xmpp presence stanza. This property contains natural-language description of an xmpp user status.
Returns:
the status for xmpp presence stanza.

getThread()
Returns the xmpp message thread.
Returns:
the xmpp message thread.

getTo()
Returns the jabber id of the event recipient.
Returns:
the recipient jabber id.

getType()
Returns the type of the event xmpp-stanza. See XMPPEvent#TYPE_GET and other stanza types.
Returns:
the xmpp-stanza type.

setBody(body)
Sets the xmpp message body.
Parameters:
body
the xmpp message body to be set.

setData(data)
Sets the xmpp message body.
Parameters:
data
the xmpp message body to be set.

setError(error)
Sets the xmpp error text.
Parameters:
error
the xmpp error text to be set.

setErrorCode(errorCode)
Sets the xmpp error code.
Parameters:
errorCode
the xmpp error code to be set.

setFrom(from)
Sets the jabber id of the event sender.
Parameters:
from
the sender jabber id to be set.

setId(id)
Sets the id of the event xmpp-stanza.
Parameters:
id
the xmpp-stanza id to be set.

setPriority(priority)
Sets the xmpp message priority.
Parameters:
priority
the xmpp message priority to be set.

setShow(show)
Sets the show-property of xmpp presence stanza. This property contains additional information about an xmpp user status. The possible values are: 'away', 'chat', 'dnd', 'xa'.
Parameters:
show
the show-property of xmpp presence stanza to be set.

setStatus(status)
Sets the status for xmpp presence stanza. This property contains natural-language description of an xmpp user status.
Parameters:
status
the status to be set for presence stanza.

setSubject(subject)
Sets the xmpp message subject.
Parameters:
subject
the xmpp message subject to be set.

setThread(thread)
Sets the xmpp message thread.
Parameters:
thread
the xmpp message thread to be set.

setTo(to)
Sets the jabber id of the event recipient.
Parameters:
to
the recipient jabber id to be set.

setType(type)
Sets the type of the event xmpp-stanza. See XMPPEvent#TYPE_GET and other stanza types.
Parameters:
type
the xmpp-stanza type to be set.

Copyright © 2015-2021 StreamScape Technologies. All rights reserved.