Overview
Package
Class
Tree
Deprecated
Index
Help
Smack
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
J
L
M
N
O
P
R
S
T
U
X
A
AVAILABLE
- Static variable in class org.jivesoftware.smack.packet.
Presence.Mode
AVAILABLE
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
AWAY
- Static variable in class org.jivesoftware.smack.packet.
Presence.Mode
AccountManager
- class org.jivesoftware.smack.
AccountManager
.
Allows creation and management of accounts on an XMPP server.
AccountManager(XMPPConnection)
- Constructor for class org.jivesoftware.smack.
AccountManager
Creates a new AccountManager instance.
AndFilter
- class org.jivesoftware.smack.filter.
AndFilter
.
Implements the logical AND operation over two packet filters.
AndFilter(PacketFilter, PacketFilter)
- Constructor for class org.jivesoftware.smack.filter.
AndFilter
Creates an AND filter using the specified filters.
Authentication
- class org.jivesoftware.smack.packet.
Authentication
.
Authentication packet, which can be used to login to a XMPP server as well as discover login information from the server.
Authentication()
- Constructor for class org.jivesoftware.smack.packet.
Authentication
Create a new authentication packet.
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
AndFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
FromContainsFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
NotFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
OrFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
PacketExtensionFilter
accept(Packet)
- Method in interface org.jivesoftware.smack.filter.
PacketFilter
Tests whether or not the specified packet should pass the filter.
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
PacketIDFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
PacketTypeFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
ThreadFilter
accept(Packet)
- Method in class org.jivesoftware.smack.filter.
ToContainsFilter
addBody(Message, String)
- Static method in class org.jivesoftware.smackx.
XHTMLManager
Adds an XHTML body to the message.
addBody(String)
- Method in class org.jivesoftware.smackx.packet.
XHTMLExtension
Adds a body to the packet.
addConnectionListener(ConnectionListener)
- Method in class org.jivesoftware.smack.
XMPPConnection
Adds a connection listener to this connection that will be notified when the connection closes or fails.
addEntry(RosterEntry)
- Method in class org.jivesoftware.smack.
RosterGroup
Adds a roster entry to this group.
addExtension(PacketExtension)
- Method in class org.jivesoftware.smack.packet.
Packet
Adds a packet extension to the packet.
addExtensionProvider(String, String, Object)
- Static method in class org.jivesoftware.smack.provider.
ProviderManager
Adds an extension provider with the specified element name and name space.
addGroupName(String)
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Adds a group name.
addIQProvider(String, String, Object)
- Static method in class org.jivesoftware.smack.provider.
ProviderManager
Adds an IQ provider (must be an instance of IQProvider or Class object that is an IQ) with the specified element name and name space.
addMessageEventNotificationListener(MessageEventNotificationListener)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Adds a message event notification listener.
addMessageEventRequestListener(MessageEventRequestListener)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Adds a message event request listener.
addMessageListener(PacketListener)
- Method in class org.jivesoftware.smack.
Chat
Adds a packet listener that will be notified of any new messages in the chat.
addMessageListener(PacketListener)
- Method in class org.jivesoftware.smack.
GroupChat
Adds a packet listener that will be notified of any new messages in the group chat.
addNotificationsRequests(Message, boolean, boolean, boolean, boolean)
- Static method in class org.jivesoftware.smackx.
MessageEventManager
Adds event notification requests to a message.
addPacketListener(PacketListener, PacketFilter)
- Method in class org.jivesoftware.smack.
XMPPConnection
Registers a packet listener with this connection.
addParticipantListener(PacketListener)
- Method in class org.jivesoftware.smack.
GroupChat
Adds a packet listener that will be notified of any new Presence packets sent to the group chat.
addPrivateDataProvider(String, String, PrivateDataProvider)
- Static method in class org.jivesoftware.smackx.
PrivateDataManager
Adds a private data provider with the specified element name and name space.
addRosterEntry(RosterEntry)
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Adds a roster entry to the packet.
addRosterEntry(RemoteRosterEntry)
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Adds a remote roster entry to the packet.
addRosterItem(RosterPacket.Item)
- Method in class org.jivesoftware.smack.packet.
RosterPacket
Adds a roster item to the packet.
addRosterListener(RosterListener)
- Method in class org.jivesoftware.smack.
Roster
Adds a listener to this roster.
addRosterListener(RosterExchangeListener)
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
Adds a listener to roster exchanges.
append(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a given text to the XHTMLText.
appendBrTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that inserts a single carriage return.
appendCloseAnchorTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that an anchor section ends.
appendCloseBlockQuoteTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that a blockquote section ends.
appendCloseCodeTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates end of text that is the code for a program.
appendCloseEmTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates end of emphasis.
appendCloseHeaderTag(int)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that a header section ends.
appendCloseInlinedQuoteTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that an inlined quote section ends.
appendCloseOrderedListTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that an ordered list section ends.
appendCloseParagraphTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates the end of a new paragraph.
appendCloseSpanTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that a span section ends.
appendCloseStrongTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that a strong section ends.
appendCloseUnorderedListTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that an unordered list section ends.
appendImageTag(String, String, String, String, String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates an image.
appendLineItemTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates the start of a new line item within a list.
appendOpenAnchorTag(String, String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that an anchor section begins.
appendOpenBlockQuoteTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that a blockquote section begins.
appendOpenCiteTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates a reference to work, such as a book, report or web site.
appendOpenCodeTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates text that is the code for a program.
appendOpenEmTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates emphasis.
appendOpenHeaderTag(int, String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates a header, a title of a section of the message.
appendOpenInlinedQuoteTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates that an inlined quote section begins.
appendOpenOrderedListTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that creates an ordered list.
appendOpenParagraphTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates the start of a new paragraph.
appendOpenSpanTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that allows to set the fonts for a span of text.
appendOpenStrongTag()
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that indicates text which should be more forceful than surrounding text.
appendOpenUnorderedListTag(String)
- Method in class org.jivesoftware.smackx.
XHTMLText
Appends a tag that creates an unordered list.
B
BOTH
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
The user and subscriber have a mutual interest in each other's presence.
C
CANCELLED
- Static variable in class org.jivesoftware.smackx.packet.
MessageEvent
CHAT
- Static variable in class org.jivesoftware.smack.packet.
Message.Type
Typically short text message used in line-by-line chat interfaces.
CHAT
- Static variable in class org.jivesoftware.smack.packet.
Presence.Mode
COMPOSING
- Static variable in class org.jivesoftware.smackx.packet.
MessageEvent
Chat
- class org.jivesoftware.smack.
Chat
.
A chat is a series of messages sent between two users.
Chat(XMPPConnection, String)
- Constructor for class org.jivesoftware.smack.
Chat
Creates a new chat with the specified user.
Chat(XMPPConnection, String, String)
- Constructor for class org.jivesoftware.smack.
Chat
Creates a new chat with the specified user and chat ID (the XMPP "thread).
ConnectionListener
- interface org.jivesoftware.smack.
ConnectionListener
.
Interface that allows for implementing classes to listen for connection closing events.
cancel()
- Method in class org.jivesoftware.smack.
PacketCollector
Explicitly cancels the packet collector so that no more results are queued up.
cancelledNotification(String, String)
- Method in interface org.jivesoftware.smackx.
MessageEventNotificationListener
Called when a notification that the receiver of the message cancelled the reply is received.
changePassword(String)
- Method in class org.jivesoftware.smack.
AccountManager
Changes the password of the currently logged-in account.
close()
- Method in class org.jivesoftware.smack.
XMPPConnection
Closes the connection by setting presence to unavailable then closing the stream to the XMPP server.
composingNotification(String, String)
- Method in interface org.jivesoftware.smackx.
MessageEventNotificationListener
Called when a notification that the receiver of the message is composing a reply is received.
composingNotificationRequested(String, String, MessageEventManager)
- Method in class org.jivesoftware.smackx.
DefaultMessageEventRequestListener
composingNotificationRequested(String, String, MessageEventManager)
- Method in interface org.jivesoftware.smackx.
MessageEventRequestListener
Called when a request that the receiver of the message is composing a reply notification is received.
connectionClosed()
- Method in interface org.jivesoftware.smack.
ConnectionListener
Notification that the connection was closed normally.
connectionClosedOnError(Exception)
- Method in interface org.jivesoftware.smack.
ConnectionListener
Notification that the connection was closed due to an exception.
contains(String)
- Method in class org.jivesoftware.smack.
Roster
Returns true if the specified XMPP address is an entry in the roster.
contains(RosterEntry)
- Method in class org.jivesoftware.smack.
RosterGroup
Returns true if the specified entry is part of this group.
contains(String)
- Method in class org.jivesoftware.smack.
RosterGroup
Returns true if the specified XMPP address is an entry in this group.
createAccount(String, String)
- Method in class org.jivesoftware.smack.
AccountManager
Creates a new account using the specified username and password.
createAccount(String, String, Map)
- Method in class org.jivesoftware.smack.
AccountManager
Creates a new account using the specified username, password and account attributes.
createChat(String)
- Method in class org.jivesoftware.smack.
XMPPConnection
Creates a new chat with the specified participant.
createEntry(String, String, String[])
- Method in class org.jivesoftware.smack.
Roster
Cretaes a new roster entry and prsence subscription.
createGroup(String)
- Method in class org.jivesoftware.smack.
Roster
Creates a new group.
createGroupChat(String)
- Method in class org.jivesoftware.smack.
XMPPConnection
Creates a new group chat connected to the specified room.
createMessage()
- Method in class org.jivesoftware.smack.
Chat
Creates a new Message to the chat participant.
createMessage()
- Method in class org.jivesoftware.smack.
GroupChat
Creates a new Message to send to the chat room.
createPacketCollector(PacketFilter)
- Method in class org.jivesoftware.smack.
XMPPConnection
Creates a new packet collector for this connection.
D
DEBUG_ENABLED
- Static variable in class org.jivesoftware.smack.
XMPPConnection
Value that indicates whether debugging is enabled.
DELIVERED
- Static variable in class org.jivesoftware.smackx.packet.
MessageEvent
DISPLAYED
- Static variable in class org.jivesoftware.smackx.packet.
MessageEvent
DO_NOT_DISTURB
- Static variable in class org.jivesoftware.smack.packet.
Presence.Mode
DefaultMessageEventRequestListener
- class org.jivesoftware.smackx.
DefaultMessageEventRequestListener
.
Default implementation of the MessageEventRequestListener interface.
DefaultMessageEventRequestListener()
- Constructor for class org.jivesoftware.smackx.
DefaultMessageEventRequestListener
DefaultPacketExtension
- class org.jivesoftware.smack.packet.
DefaultPacketExtension
.
Default implementation of the PacketExtension interface.
DefaultPacketExtension(String, String)
- Constructor for class org.jivesoftware.smack.packet.
DefaultPacketExtension
Creates a new generic packet extension.
DefaultPrivateData
- class org.jivesoftware.smackx.packet.
DefaultPrivateData
.
Default implementation of the PrivateData interface.
DefaultPrivateData(String, String)
- Constructor for class org.jivesoftware.smackx.packet.
DefaultPrivateData
Creates a new generic private data object.
decodeBase64(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Decodes a base64 String.
deleteAccount()
- Method in class org.jivesoftware.smack.
AccountManager
Deletes the currently logged-in account from the server.
deleteProperty(String)
- Method in class org.jivesoftware.smack.packet.
Packet
Deletes a property.
deliveredNotification(String, String)
- Method in interface org.jivesoftware.smackx.
MessageEventNotificationListener
Called when a notification of message delivered is received.
deliveredNotificationRequested(String, String, MessageEventManager)
- Method in class org.jivesoftware.smackx.
DefaultMessageEventRequestListener
deliveredNotificationRequested(String, String, MessageEventManager)
- Method in interface org.jivesoftware.smackx.
MessageEventRequestListener
Called when a request for message delivered notification is received.
destroy()
- Method in class org.jivesoftware.smackx.
MessageEventManager
destroy()
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
displayedNotification(String, String)
- Method in interface org.jivesoftware.smackx.
MessageEventNotificationListener
Called when a notification of message displayed is received.
displayedNotificationRequested(String, String, MessageEventManager)
- Method in class org.jivesoftware.smackx.
DefaultMessageEventRequestListener
displayedNotificationRequested(String, String, MessageEventManager)
- Method in interface org.jivesoftware.smackx.
MessageEventRequestListener
Called when a request for message displayed notification is received.
E
ERROR
- Static variable in class org.jivesoftware.smack.packet.
IQ.Type
ERROR
- Static variable in class org.jivesoftware.smack.packet.
Message.Type
indicates a messaging error.
ERROR
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
EXTENDED_AWAY
- Static variable in class org.jivesoftware.smack.packet.
Presence.Mode
encodeBase64(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Encodes a String as a base64 String.
encodeBase64(byte[])
- Static method in class org.jivesoftware.smack.util.
StringUtils
Encodes a byte array into a base64 String.
encodeHex(byte[])
- Static method in class org.jivesoftware.smack.util.
StringUtils
Turns an array of bytes into a String representing each byte as an unsigned hex number.
entriesReceived(String, Iterator)
- Method in interface org.jivesoftware.smackx.
RosterExchangeListener
Called when roster entries are received as part of a roster exchange.
equals(Object)
- Method in class org.jivesoftware.smack.
RosterEntry
escapeForXML(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Escapes all necessary characters in the String so that it can be used in an XML doc.
F
FROM
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
The subscriber is interested in receiving presence updates from the user.
FromContainsFilter
- class org.jivesoftware.smack.filter.
FromContainsFilter
.
Filters for packets where the "from" field contains a specified value.
FromContainsFilter(String)
- Constructor for class org.jivesoftware.smack.filter.
FromContainsFilter
Creates a "from" contains filter using the "from" field part.
finalize()
- Method in class org.jivesoftware.smackx.
MessageEventManager
finalize()
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
fromString(String)
- Static method in class org.jivesoftware.smack.packet.
IQ.Type
Converts a String into the corresponding types.
fromString(String)
- Static method in class org.jivesoftware.smack.packet.
Message.Type
Converts a String value into its Type representation.
fromString(String)
- Static method in class org.jivesoftware.smack.packet.
Presence.Mode
Returns the mode constant associated with the String value.
fromString(String)
- Static method in class org.jivesoftware.smack.packet.
Presence.Type
Returns the type constant associated with the String value.
fromString(String)
- Static method in class org.jivesoftware.smack.packet.
RosterPacket.ItemStatus
fromString(String)
- Static method in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
G
GET
- Static variable in class org.jivesoftware.smack.packet.
IQ.Type
GROUP_CHAT
- Static variable in class org.jivesoftware.smack.packet.
Message.Type
Chat message sent to a groupchat server for group chats.
GroupChat
- class org.jivesoftware.smack.
GroupChat
.
A GroupChat is a conversation that takes place among many users in a virtual room.
GroupChat(XMPPConnection, String)
- Constructor for class org.jivesoftware.smack.
GroupChat
Creates a new group chat with the specified connection and room name.
getAccountAttributes()
- Method in class org.jivesoftware.smack.
AccountManager
Returns an Iterator for the (String) names of the required account attributes.
getAccountInstructions()
- Method in class org.jivesoftware.smack.
AccountManager
Returns the instructions for creating a new account, or
null
if there are no instructions.
getAccountManager()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns an account manager instance for this connection.
getAttributes()
- Method in class org.jivesoftware.smack.packet.
Registration
Returns the map of String key/value pairs of account attributes.
getBodies(Message)
- Static method in class org.jivesoftware.smackx.
XHTMLManager
Returns an Iterator for the XHTML bodies in the message.
getBodies()
- Method in class org.jivesoftware.smackx.packet.
XHTMLExtension
Returns an Iterator for the bodies in the packet.
getBodiesCount()
- Method in class org.jivesoftware.smackx.packet.
XHTMLExtension
Returns a count of the bodies in the XHTML packet.
getBody()
- Method in class org.jivesoftware.smack.packet.
Message
Returns the body of the message, or null if the body has not been set.
getChatID()
- Method in class org.jivesoftware.smack.
Chat
Returns the unique id of this chat, which corresponds to the
thread
field of XMPP messages.
getChildElementXML()
- Method in class org.jivesoftware.smack.packet.
Authentication
getChildElementXML()
- Method in class org.jivesoftware.smack.packet.
IQ
Returns the sub-element XML section of the IQ packet, or
null
if there isn't one.
getChildElementXML()
- Method in class org.jivesoftware.smack.packet.
Registration
getChildElementXML()
- Method in class org.jivesoftware.smack.packet.
RosterPacket
getChildElementXML()
- Method in class org.jivesoftware.smackx.packet.
Time
getCode()
- Method in class org.jivesoftware.smack.packet.
XMPPError
Returns the error code.
getConnectionID()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns the connection ID for this connection, which is the value set by the server when opening a XMPP stream.
getDigest()
- Method in class org.jivesoftware.smack.packet.
Authentication
Returns the password digest or
null
if the digest hasn't been set.
getDisplay()
- Method in class org.jivesoftware.smackx.packet.
Time
Returns the local (non-utc) time in human-friendly format.
getElementName()
- Method in class org.jivesoftware.smack.packet.
DefaultPacketExtension
Returns the XML element name of the extension sub-packet root element.
getElementName()
- Method in interface org.jivesoftware.smack.packet.
PacketExtension
Returns the root element name.
getElementName()
- Method in class org.jivesoftware.smackx.packet.
DefaultPrivateData
Returns the XML element name of the private data sub-packet root element.
getElementName()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Returns the XML element name of the extension sub-packet root element.
getElementName()
- Method in interface org.jivesoftware.smackx.packet.
PrivateData
Returns the root element name.
getElementName()
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Returns the XML element name of the extension sub-packet root element.
getElementName()
- Method in class org.jivesoftware.smackx.packet.
XHTMLExtension
Returns the XML element name of the extension sub-packet root element.
getEntries()
- Method in class org.jivesoftware.smack.
Roster
Returns all entries in the roster, including entries that don't belong to any groups.
getEntries()
- Method in class org.jivesoftware.smack.
RosterGroup
Returns an iterator for the entries in the group.
getEntry(String)
- Method in class org.jivesoftware.smack.
Roster
Returns the roster entry associated with the given XMPP address or
null
if the user is not an entry in the roster.
getEntry(String)
- Method in class org.jivesoftware.smack.
RosterGroup
Returns the roster entry associated with the given XMPP address or
null
if the user is not an entry in the group.
getEntryCount()
- Method in class org.jivesoftware.smack.
Roster
Returns a count of the entries in the roster.
getEntryCount()
- Method in class org.jivesoftware.smack.
RosterGroup
Returns the number of entries in the group.
getEntryCount()
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Returns a count of the entries in the roster exchange.
getError()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns the error associated with this packet, or
null
if there are no errors.
getEventTypes()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Returns the types of events.
getExtension(String, String)
- Method in class org.jivesoftware.smack.packet.
Packet
Returns the first packet extension that matches the specified element name and namespace, or
null
if it doesn't exist.
getExtensionProvider(String, String)
- Static method in class org.jivesoftware.smack.provider.
ProviderManager
Returns the packet extension provider registered to the specified XML element name and namespace.
getExtensions()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns an Iterator for the packet extensions attached to the packet.
getExtensionsXML()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns the extension sub-packets (including properties data) as an XML String, or the Empty String if there are no packet extensions.
getFrom()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns who the packet is being sent "from" or
null
if the value is not set.
getGroup(String)
- Method in class org.jivesoftware.smack.
Roster
Returns the roster group with the specified name, or
null
if the group doesn't exist.
getGroupArrayNames()
- Method in class org.jivesoftware.smackx.
RemoteRosterEntry
Returns a String array for the group names that the roster entry belongs to.
getGroupCount()
- Method in class org.jivesoftware.smack.
Roster
Returns the number of the groups in the roster.
getGroupNames()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Returns an Iterator for the group names (as Strings) that the roster item belongs to.
getGroupNames()
- Method in class org.jivesoftware.smackx.
RemoteRosterEntry
Returns an Iterator for the group names (as Strings) that the roster entry belongs to.
getGroups()
- Method in class org.jivesoftware.smack.
Roster
Returns an iterator the for all the roster groups.
getGroups()
- Method in class org.jivesoftware.smack.
RosterEntry
Returns an iterator for all the roster groups that this entry belongs to.
getHost()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns the host name of the XMPP server for this connection.
getIQProvider(String, String)
- Static method in class org.jivesoftware.smack.provider.
ProviderManager
Returns the IQ provider registered to the specified XML element name and namespace.
getInstructions()
- Method in class org.jivesoftware.smack.packet.
Registration
Returns the registration instructions, or
null
if no instructions have been set.
getItemStatus()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Returns the roster item status.
getItemType()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Returns the roster item type.
getMessage()
- Method in class org.jivesoftware.smack.packet.
XMPPError
Returns the message describing the error, or null if there is no message.
getMode()
- Method in class org.jivesoftware.smack.packet.
Presence
Returns the mode of the presence update.
getName()
- Method in class org.jivesoftware.smack.
RosterEntry
Returns the name associated with this entry.
getName()
- Method in class org.jivesoftware.smack.
RosterGroup
Returns the name of the group.
getName()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Returns the user's name.
getName()
- Method in class org.jivesoftware.smackx.
RemoteRosterEntry
Returns the user's name.
getNames()
- Method in class org.jivesoftware.smack.packet.
DefaultPacketExtension
Returns an Iterator for the names that can be used to get values of the packet extension.
getNames()
- Method in class org.jivesoftware.smackx.packet.
DefaultPrivateData
Returns an Iterator for the names that can be used to get values of the private data.
getNamespace()
- Method in class org.jivesoftware.smack.packet.
DefaultPacketExtension
Returns the XML namespace of the extension sub-packet root element.
getNamespace()
- Method in interface org.jivesoftware.smack.packet.
PacketExtension
Returns the root element XML namespace.
getNamespace()
- Method in class org.jivesoftware.smackx.packet.
DefaultPrivateData
Returns the XML namespace of the private data sub-packet root element.
getNamespace()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Returns the XML namespace of the extension sub-packet root element.
getNamespace()
- Method in interface org.jivesoftware.smackx.packet.
PrivateData
Returns the root element XML namespace.
getNamespace()
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Returns the XML namespace of the extension sub-packet root element.
getNamespace()
- Method in class org.jivesoftware.smackx.packet.
XHTMLExtension
Returns the XML namespace of the extension sub-packet root element.
getNickname()
- Method in class org.jivesoftware.smack.
GroupChat
Returns the nickname that was used to join the room, or
null
if not currently joined.
getPacketFilter()
- Method in class org.jivesoftware.smack.
PacketCollector
Returns the packet filter associated with this packet collector.
getPacketID()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns the unique ID of the packet.
getPacketID()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Returns the unique ID of the message that requested to be notified of the event.
getParticipant()
- Method in class org.jivesoftware.smack.
Chat
Returns the name of the user the chat is with.
getParticipantCount()
- Method in class org.jivesoftware.smack.
GroupChat
Returns the number of participants in the group chat.
getParticipants()
- Method in class org.jivesoftware.smack.
GroupChat
Returns an Iterator (of Strings) for the list of fully qualified participants in the group chat.
getPassword()
- Method in class org.jivesoftware.smack.packet.
Authentication
Returns the plain text password or
null
if the password hasn't been set.
getPassword()
- Method in class org.jivesoftware.smack.packet.
Registration
Returns the password, or
null
if no password has been set.
getPort()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns the port number of the XMPP server for this connection.
getPresence(String)
- Method in class org.jivesoftware.smack.
Roster
Returns the presence info for a particular user, or
null
if there is no presence information.
getPriority()
- Method in class org.jivesoftware.smack.packet.
Presence
Returns the priority of the presence, or -1 if no priority has been set.
getPrivateData(String, String)
- Method in class org.jivesoftware.smackx.
PrivateDataManager
Returns the private data specified by the given element name and namespace.
getPrivateDataProvider(String, String)
- Static method in class org.jivesoftware.smackx.
PrivateDataManager
Returns the private data provider registered to the specified XML element name and namespace.
getProperty(String)
- Method in class org.jivesoftware.smack.packet.
Packet
Returns the packet property with the specified name or
null
if the property doesn't exist.
getPropertyNames()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns an Iterator for all the property names that are set.
getResource()
- Method in class org.jivesoftware.smack.packet.
Authentication
Returns the resource or
null
if the resource hasn't been set.
getRoom()
- Method in class org.jivesoftware.smack.
GroupChat
Returns the name of the room this GroupChat object represents.
getRoster()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns the roster for the user logged into the server.
getRosterEntries()
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Returns an Iterator for the roster entries in the packet.
getRosterItemCount()
- Method in class org.jivesoftware.smack.packet.
RosterPacket
Returns the number of roster items in this roster packet.
getRosterItems()
- Method in class org.jivesoftware.smack.packet.
RosterPacket
Returns an Iterator for the roster items in the packet.
getStatus()
- Method in class org.jivesoftware.smack.packet.
Presence
Returns the status message of the presence update, or
null
if there is not a status.
getSubject()
- Method in class org.jivesoftware.smack.packet.
Message
Returns the subject of the message, or null if the subject has not been set.
getSubscriptionMode()
- Method in class org.jivesoftware.smack.
Roster
Returns the subscription processing mode, which dictates what action Smack will take when subscription requests from other users are made.
getThread()
- Method in class org.jivesoftware.smack.packet.
Message
Returns the thread id of the message, which is a unique identifier for a sequence of "chat" messages.
getTime()
- Method in class org.jivesoftware.smackx.packet.
Time
Returns the local time or
null
if the time hasn't been set.
getTo()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns who the packet is being sent "to", or
null
if the value is not set.
getType()
- Method in class org.jivesoftware.smack.
RosterEntry
Returns the roster subscription type of the entry.
getType()
- Method in class org.jivesoftware.smack.packet.
IQ
Returns the type of the IQ packet.
getType()
- Method in class org.jivesoftware.smack.packet.
Message
Returns the type of the message.
getType()
- Method in class org.jivesoftware.smack.packet.
Presence
Returns the type of this presence packet.
getTz()
- Method in class org.jivesoftware.smackx.packet.
Time
Returns the time zone.
getUnfiledEntries()
- Method in class org.jivesoftware.smack.
Roster
Returns an Iterator for the unfiled roster entries.
getUnfiledEntryCount()
- Method in class org.jivesoftware.smack.
Roster
Returns a count of the unfiled entries in the roster.
getUser()
- Method in class org.jivesoftware.smack.
RosterEntry
Returns the JID of the user associated with this entry.
getUser()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns the full XMPP address of the user that is logged in to the connection or
null
if not logged in yet.
getUser()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Returns the user.
getUser()
- Method in class org.jivesoftware.smackx.
RemoteRosterEntry
Returns the user.
getUsername()
- Method in class org.jivesoftware.smack.packet.
Authentication
Returns the username, or
null
if the username hasn't been sent.
getUsername()
- Method in class org.jivesoftware.smack.packet.
Registration
Returns the username, or
null
if no username has ben set.
getUtc()
- Method in class org.jivesoftware.smackx.packet.
Time
Returns the time as a UTC formatted String using the format CCYYMMDDThh:mm:ss.
getValue(String)
- Method in class org.jivesoftware.smack.packet.
DefaultPacketExtension
Returns a packet extension value given a name.
getValue(String)
- Method in class org.jivesoftware.smackx.packet.
DefaultPrivateData
Returns a value given a name.
getWrappedThrowable()
- Method in class org.jivesoftware.smack.
XMPPException
Returns the Throwable asscociated with this exception, or
null
if there isn't one.
getXMPPError()
- Method in class org.jivesoftware.smack.
XMPPException
Returns the XMPPError asscociated with this exception, or
null
if there isn't one.
H
HEADLINE
- Static variable in class org.jivesoftware.smack.packet.
Message.Type
Text message to be displayed in scrolling marquee displays.
hash(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Hashes a String using the SHA-1 algorithm and returns the result as a String of hexadecimal numbers.
I
INVISIBLE
- Static variable in class org.jivesoftware.smack.packet.
Presence.Mode
IQ
- class org.jivesoftware.smack.packet.
IQ
.
The base IQ (Info/Query) packet.
IQ()
- Constructor for class org.jivesoftware.smack.packet.
IQ
IQ.Type
- class org.jivesoftware.smack.packet.
IQ.Type
.
A class to represent the type of the IQ packet.
IQProvider
- interface org.jivesoftware.smack.provider.
IQProvider
.
An interface for parsing custom IQ packets.
isAnonymous()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns true if currently authenticated anonymously.
isAuthenticated()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns true if currently authenticated by successfully calling the login method.
isCancelled()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a notification returns if the receiver of the message cancelled composing a reply.
isComposing()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request returns if the sender of the message requests to be notified when the receiver is composing a reply.
isConnected()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns true if currently connected to the XMPP server.
isDelivered()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request returns if the sender of the message requests to be notified when the message is delivered.
isDisplayed()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request returns if the sender of the message requests to be notified when the message is displayed.
isJoined()
- Method in class org.jivesoftware.smack.
GroupChat
Returns true if currently in the group chat (after calling the
GroupChat.join(String)
method.
isMessageEventRequest()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Returns true if this MessageEvent is a request for notifications.
isOffline()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request returns if the sender of the message requests to be notified when the receiver of the message is offline.
isSecureConnection()
- Method in class org.jivesoftware.smack.
SSLXMPPConnection
isSecureConnection()
- Method in class org.jivesoftware.smack.
XMPPConnection
Returns true if the connection is a secured one, such as an SSL connection.
isXHTMLMessage(Message)
- Static method in class org.jivesoftware.smackx.
XHTMLManager
Returns true if the message contains an XHTML extension.
J
join(String)
- Method in class org.jivesoftware.smack.
GroupChat
Joins the chat room using the specified nickname.
join(String, long)
- Method in class org.jivesoftware.smack.
GroupChat
Joins the chat room using the specified nickname.
L
leave()
- Method in class org.jivesoftware.smack.
GroupChat
Leave the chat room.
login(String, String)
- Method in class org.jivesoftware.smack.
XMPPConnection
Logs in to the server using the strongest authentication mode supported by the server, then set our presence to available.
login(String, String, String)
- Method in class org.jivesoftware.smack.
XMPPConnection
Logs in to the server using the strongest authentication mode supported by the server, then set our presence to available.
loginAnonymously()
- Method in class org.jivesoftware.smack.
XMPPConnection
Logs in to the server anonymously.
M
Message
- class org.jivesoftware.smack.packet.
Message
.
Represents XMPP message packets.
Message()
- Constructor for class org.jivesoftware.smack.packet.
Message
Creates a new, "normal" message.
Message(String)
- Constructor for class org.jivesoftware.smack.packet.
Message
Creates a new "normal" message to the specified recipient.
Message(String, Message.Type)
- Constructor for class org.jivesoftware.smack.packet.
Message
Creates a new message of the specified type to a recipient.
Message.Type
- class org.jivesoftware.smack.packet.
Message.Type
.
Represents the type of a message.
MessageEvent
- class org.jivesoftware.smackx.packet.
MessageEvent
.
Represents message events relating to the delivery, display, composition and cancellation of messages.
MessageEvent()
- Constructor for class org.jivesoftware.smackx.packet.
MessageEvent
MessageEventManager
- class org.jivesoftware.smackx.
MessageEventManager
.
Manages message events requests and notifications.
MessageEventManager(XMPPConnection)
- Constructor for class org.jivesoftware.smackx.
MessageEventManager
Creates a new message event manager.
MessageEventNotificationListener
- interface org.jivesoftware.smackx.
MessageEventNotificationListener
.
A listener that is fired anytime a message event notification is received.
MessageEventProvider
- class org.jivesoftware.smackx.provider.
MessageEventProvider
.
The MessageEventProvider parses Message Event packets.
MessageEventProvider()
- Constructor for class org.jivesoftware.smackx.provider.
MessageEventProvider
Creates a new MessageEventProvider.
MessageEventRequestListener
- interface org.jivesoftware.smackx.
MessageEventRequestListener
.
A listener that is fired anytime a message event request is received.
N
NONE
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
The user and subscriber have no interest in each other's presence.
NORMAL
- Static variable in class org.jivesoftware.smack.packet.
Message.Type
(Default) a normal text message used in email like interface.
NotFilter
- class org.jivesoftware.smack.filter.
NotFilter
.
Implements the logical NOT operation on a packet filter.
NotFilter(PacketFilter)
- Constructor for class org.jivesoftware.smack.filter.
NotFilter
Creates a NOT filter using the specified filter.
nextMessage()
- Method in class org.jivesoftware.smack.
Chat
Returns the next available message in the chat.
nextMessage(long)
- Method in class org.jivesoftware.smack.
Chat
Returns the next available message in the chat.
nextMessage()
- Method in class org.jivesoftware.smack.
GroupChat
Returns the next available message in the chat.
nextMessage(long)
- Method in class org.jivesoftware.smack.
GroupChat
Returns the next available message in the chat.
nextResult()
- Method in class org.jivesoftware.smack.
PacketCollector
Returns the next available packet.
nextResult(long)
- Method in class org.jivesoftware.smack.
PacketCollector
Returns the next available packet.
O
OFFLINE
- Static variable in class org.jivesoftware.smackx.packet.
MessageEvent
OrFilter
- class org.jivesoftware.smack.filter.
OrFilter
.
Implements the logical OR operation over two packet filters.
OrFilter(PacketFilter, PacketFilter)
- Constructor for class org.jivesoftware.smack.filter.
OrFilter
Creates an OR filter using the specified filters.
offlineNotification(String, String)
- Method in interface org.jivesoftware.smackx.
MessageEventNotificationListener
Called when a notification that the receiver of the message is offline is received.
offlineNotificationRequested(String, String, MessageEventManager)
- Method in class org.jivesoftware.smackx.
DefaultMessageEventRequestListener
offlineNotificationRequested(String, String, MessageEventManager)
- Method in interface org.jivesoftware.smackx.
MessageEventRequestListener
Called when a request that the receiver of the message is offline is received.
org.jivesoftware.smack
- package org.jivesoftware.smack
Core classes of the Smack API.
org.jivesoftware.smack.filter
- package org.jivesoftware.smack.filter
Allows
PacketCollector
and
PacketListener
instances to filter for packets with particular attributes.
org.jivesoftware.smack.packet
- package org.jivesoftware.smack.packet
XML packets that are part of the XMPP protocol.
org.jivesoftware.smack.provider
- package org.jivesoftware.smack.provider
Provides pluggable parsing of incoming IQ's and packet extensions.
org.jivesoftware.smack.util
- package org.jivesoftware.smack.util
Utility classes.
org.jivesoftware.smackx
- package org.jivesoftware.smackx
Smack extensions API.
org.jivesoftware.smackx.packet
- package org.jivesoftware.smackx.packet
XML packets that are part of the XMPP extension protocols.
org.jivesoftware.smackx.provider
- package org.jivesoftware.smackx.provider
Provides pluggable parsing logic for Smack extensions.
P
Packet
- class org.jivesoftware.smack.packet.
Packet
.
Base class for XMPP packets.
Packet()
- Constructor for class org.jivesoftware.smack.packet.
Packet
PacketCollector
- class org.jivesoftware.smack.
PacketCollector
.
Provides a mechanism to collect packets into a result queue that pass a specified filter.
PacketCollector(PacketReader, PacketFilter)
- Constructor for class org.jivesoftware.smack.
PacketCollector
Creates a new packet collector.
PacketExtension
- interface org.jivesoftware.smack.packet.
PacketExtension
.
Interface to represent packet extensions.
PacketExtensionFilter
- class org.jivesoftware.smack.filter.
PacketExtensionFilter
.
Filters for packets with a particular type of packet extension.
PacketExtensionFilter(String, String)
- Constructor for class org.jivesoftware.smack.filter.
PacketExtensionFilter
Creates a new packet extension filter.
PacketExtensionProvider
- interface org.jivesoftware.smack.provider.
PacketExtensionProvider
.
An interface for parsing custom packets extensions.
PacketFilter
- interface org.jivesoftware.smack.filter.
PacketFilter
.
Defines a way to filter packets for particular attributes.
PacketIDFilter
- class org.jivesoftware.smack.filter.
PacketIDFilter
.
Filters for packets with a particular packet ID.
PacketIDFilter(String)
- Constructor for class org.jivesoftware.smack.filter.
PacketIDFilter
Creates a new packet ID filter using the specified packet ID.
PacketListener
- interface org.jivesoftware.smack.
PacketListener
.
Provides a mechanism to listen for packets that pass a specified filter.
PacketTypeFilter
- class org.jivesoftware.smack.filter.
PacketTypeFilter
.
Filters for packets of a particular type.
PacketTypeFilter(Class)
- Constructor for class org.jivesoftware.smack.filter.
PacketTypeFilter
Creates a new packet type filter that will filter for packets that are the same type as
packetType
.
Presence
- class org.jivesoftware.smack.packet.
Presence
.
Represents XMPP presence packets.
Presence(Presence.Type)
- Constructor for class org.jivesoftware.smack.packet.
Presence
Creates a new presence update.
Presence(Presence.Type, String, int, Presence.Mode)
- Constructor for class org.jivesoftware.smack.packet.
Presence
Creates a new presence update with a specified status, priority, and mode.
Presence.Mode
- class org.jivesoftware.smack.packet.
Presence.Mode
.
A typsafe enum class to represent the presecence mode.
Presence.Type
- class org.jivesoftware.smack.packet.
Presence.Type
.
A typsafe enum class to represent the presecence type.
PrivateData
- interface org.jivesoftware.smackx.packet.
PrivateData
.
Interface to represent private data.
PrivateDataManager
- class org.jivesoftware.smackx.
PrivateDataManager
.
Manages private data, which is a mechanism to allow users to store arbitrary XML data on an XMPP server.
PrivateDataManager(XMPPConnection)
- Constructor for class org.jivesoftware.smackx.
PrivateDataManager
Creates a new private data manager.
PrivateDataManager(XMPPConnection, String)
- Constructor for class org.jivesoftware.smackx.
PrivateDataManager
Creates a new private data manager for a specific user (special case).
PrivateDataManager.PrivateDataIQProvider
- class org.jivesoftware.smackx.
PrivateDataManager.PrivateDataIQProvider
.
An IQ provider to parse IQ results containing private data.
PrivateDataManager.PrivateDataIQProvider()
- Constructor for class org.jivesoftware.smackx.
PrivateDataManager.PrivateDataIQProvider
PrivateDataProvider
- interface org.jivesoftware.smackx.provider.
PrivateDataProvider
.
An interface for parsing custom private data.
ProviderManager
- class org.jivesoftware.smack.provider.
ProviderManager
.
Manages providers for parsing custom XML sub-documents of XMPP packets.
ProviderManager()
- Constructor for class org.jivesoftware.smack.provider.
ProviderManager
parseBareAddress(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Returns the XMPP address with any resource information removed.
parseExtension(XmlPullParser)
- Method in interface org.jivesoftware.smack.provider.
PacketExtensionProvider
Parse an extension sub-packet and create a PacketExtension instance.
parseExtension(XmlPullParser)
- Method in class org.jivesoftware.smackx.provider.
MessageEventProvider
Parses a MessageEvent packet (extension sub-packet).
parseExtension(XmlPullParser)
- Method in class org.jivesoftware.smackx.provider.
RosterExchangeProvider
Parses a RosterExchange packet (extension sub-packet).
parseExtension(XmlPullParser)
- Method in class org.jivesoftware.smackx.provider.
XHTMLExtensionProvider
Parses a XHTMLExtension packet (extension sub-packet).
parseIQ(XmlPullParser)
- Method in interface org.jivesoftware.smack.provider.
IQProvider
Parse the IQ sub-document and create an IQ instance.
parseIQ(XmlPullParser)
- Method in class org.jivesoftware.smackx.
PrivateDataManager.PrivateDataIQProvider
parseName(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Returns the name portion of a XMPP address.
parsePrivateData(XmlPullParser)
- Method in interface org.jivesoftware.smackx.provider.
PrivateDataProvider
Parse the private data sub-document and create a PrivateData instance.
parseResource(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Returns the name portion of a XMPP address.
parseServer(String)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Returns the name portion of a XMPP address.
pollMessage()
- Method in class org.jivesoftware.smack.
Chat
Polls for and returns the next message, or
null
if there isn't a message immediately available.
pollMessage()
- Method in class org.jivesoftware.smack.
GroupChat
Polls for and returns the next message, or
null
if there isn't a message immediately available.
pollResult()
- Method in class org.jivesoftware.smack.
PacketCollector
Polls to see if a packet is currently available and returns it, or immediately returns
null
if no packets are currently in the result queue.
presenceChanged(String)
- Method in interface org.jivesoftware.smack.
RosterListener
Called when the presence of a roster entry is changed.
printStackTrace()
- Method in class org.jivesoftware.smack.
XMPPException
printStackTrace(PrintStream)
- Method in class org.jivesoftware.smack.
XMPPException
printStackTrace(PrintWriter)
- Method in class org.jivesoftware.smack.
XMPPException
processPacket(Packet)
- Method in class org.jivesoftware.smack.
PacketCollector
Processes a packet to see if it meets the criteria for this packet collector.
processPacket(Packet)
- Method in interface org.jivesoftware.smack.
PacketListener
Process the next packet sent to this packet listener.
R
REMOVE
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
The user wishes to stop receiving presence updates from the subscriber.
RESULT
- Static variable in class org.jivesoftware.smack.packet.
IQ.Type
Registration
- class org.jivesoftware.smack.packet.
Registration
.
Represents registration packets.
Registration()
- Constructor for class org.jivesoftware.smack.packet.
Registration
RemoteRosterEntry
- class org.jivesoftware.smackx.
RemoteRosterEntry
.
Represents a roster item, which consists of a JID and , their name and the groups the roster item belongs to.
RemoteRosterEntry(String, String, String[])
- Constructor for class org.jivesoftware.smackx.
RemoteRosterEntry
Creates a new remote roster entry.
Roster
- class org.jivesoftware.smack.
Roster
.
Represents a user's roster, which is the collection of users a person receives presence updates for.
RosterEntry
- class org.jivesoftware.smack.
RosterEntry
.
Each user in your roster is represented by a roster entry, which contains the user's JID and a name or nickname you assign.
RosterExchange
- class org.jivesoftware.smackx.packet.
RosterExchange
.
Represents XMPP Roster Item Exchange packets.
RosterExchange()
- Constructor for class org.jivesoftware.smackx.packet.
RosterExchange
Creates a new empty roster exchange package.
RosterExchange(Roster)
- Constructor for class org.jivesoftware.smackx.packet.
RosterExchange
Creates a new roster exchange package with the entries specified in roster.
RosterExchangeListener
- interface org.jivesoftware.smackx.
RosterExchangeListener
.
A listener that is fired anytime a roster exchange is received.
RosterExchangeManager
- class org.jivesoftware.smackx.
RosterExchangeManager
.
Manages Roster exchanges.
RosterExchangeManager(XMPPConnection)
- Constructor for class org.jivesoftware.smackx.
RosterExchangeManager
Creates a new roster exchange manager.
RosterExchangeProvider
- class org.jivesoftware.smackx.provider.
RosterExchangeProvider
.
The RosterExchangeProvider parses RosterExchange packets.
RosterExchangeProvider()
- Constructor for class org.jivesoftware.smackx.provider.
RosterExchangeProvider
Creates a new RosterExchangeProvider.
RosterGroup
- class org.jivesoftware.smack.
RosterGroup
.
A group of roster entries.
RosterListener
- interface org.jivesoftware.smack.
RosterListener
.
A listener that is fired any time a roster is changed or the presence of a user in the roster is changed.
RosterPacket
- class org.jivesoftware.smack.packet.
RosterPacket
.
Represents XMPP roster packets.
RosterPacket()
- Constructor for class org.jivesoftware.smack.packet.
RosterPacket
RosterPacket.Item
- class org.jivesoftware.smack.packet.
RosterPacket.Item
.
A roster item, which consists of a JID, their name, the type of subscription, and the groups the roster item belongs to.
RosterPacket.Item(String, String)
- Constructor for class org.jivesoftware.smack.packet.
RosterPacket.Item
Creates a new roster item.
RosterPacket.ItemStatus
- class org.jivesoftware.smack.packet.
RosterPacket.ItemStatus
.
The subscription status of a roster item.
RosterPacket.ItemType
- class org.jivesoftware.smack.packet.
RosterPacket.ItemType
.
The subscription type of a roster item.
RosterPacket.ItemType(String)
- Constructor for class org.jivesoftware.smack.packet.
RosterPacket.ItemType
Returns the item type associated with the specified string.
randomString(int)
- Static method in class org.jivesoftware.smack.util.
StringUtils
Returns a random String of numbers and letters (lower and upper case) of the specified length.
reload()
- Method in class org.jivesoftware.smack.
Roster
Reloads the entire roster from the server.
removeConnectionListener(ConnectionListener)
- Method in class org.jivesoftware.smack.
XMPPConnection
Removes a connection listener from this connection.
removeEntry(RosterEntry)
- Method in class org.jivesoftware.smack.
Roster
Removes a roster entry from the roster.
removeEntry(RosterEntry)
- Method in class org.jivesoftware.smack.
RosterGroup
Removes a roster entry from this group.
removeExtension(PacketExtension)
- Method in class org.jivesoftware.smack.packet.
Packet
Removes a packet extension from the packet.
removeGroupName(String)
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Removes a group name.
removeMessageEventNotificationListener(MessageEventNotificationListener)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Removes a message event notification listener.
removeMessageEventRequestListener(MessageEventRequestListener)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Removes a message event request listener.
removePacketListener(PacketListener)
- Method in class org.jivesoftware.smack.
XMPPConnection
Removes a packet listener from this connection.
removeRosterListener(RosterListener)
- Method in class org.jivesoftware.smack.
Roster
Removes a listener from this roster.
removeRosterListener(RosterExchangeListener)
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
Removes a listener from roster exchanges.
rosterModified()
- Method in interface org.jivesoftware.smack.
RosterListener
Called when a roster entry is added or removed.
S
SET
- Static variable in class org.jivesoftware.smack.packet.
IQ.Type
SSLXMPPConnection
- class org.jivesoftware.smack.
SSLXMPPConnection
.
Creates an SSL connection to a XMPP server.
SSLXMPPConnection(String)
- Constructor for class org.jivesoftware.smack.
SSLXMPPConnection
Creates a new SSL connection to the specified host on the default SSL port (5223).
SSLXMPPConnection(String, int)
- Constructor for class org.jivesoftware.smack.
SSLXMPPConnection
Creates a new SSL connection to the specified host on the specified port.
SUBCRIPTION_ACCEPT_ALL
- Static variable in class org.jivesoftware.smack.
Roster
Automatically accept all subscription requests.
SUBCRIPTION_REJECT_ALL
- Static variable in class org.jivesoftware.smack.
Roster
Automatically reject all subscription requests.
SUBSCRIBE
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
SUBSCRIBED
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
SUBSCRIPTION_MANUAL
- Static variable in class org.jivesoftware.smack.
Roster
Subscription requests are ignored, which means they must be manually processed by registering a listener for presence packets and then looking for any presence requests that have the type Presence.Type.SUBSCRIBE.
SUBSCRIPTION_PENDING
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemStatus
Request to subcribe.
StringUtils
- class org.jivesoftware.smack.util.
StringUtils
.
A collection of utility methods for String objects.
send(Roster, String)
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
Sends a roster to userID.
send(RosterEntry, String)
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
Sends a roster entry to userID.
send(RosterGroup, String)
- Method in class org.jivesoftware.smackx.
RosterExchangeManager
Sends a roster group to userID.
sendCancelledNotification(String, String)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Sends the notification that the receiver of the message has cancelled composing a reply.
sendComposingNotification(String, String)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Sends the notification that the receiver of the message is composing a reply
sendDeliveredNotification(String, String)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Sends the notification that the message was delivered to the sender of the original message
sendDisplayedNotification(String, String)
- Method in class org.jivesoftware.smackx.
MessageEventManager
Sends the notification that the message was displayed to the sender of the original message
sendMessage(String)
- Method in class org.jivesoftware.smack.
Chat
Sends the specified text as a message to the other chat participant.
sendMessage(Message)
- Method in class org.jivesoftware.smack.
Chat
Sends a message to the other chat participant.
sendMessage(String)
- Method in class org.jivesoftware.smack.
GroupChat
Sends a message to the chat room.
sendMessage(Message)
- Method in class org.jivesoftware.smack.
GroupChat
Sends a Message to the chat room.
sendPacket(Packet)
- Method in class org.jivesoftware.smack.
XMPPConnection
Sends the specified packet to the server.
setAttributes(Map)
- Method in class org.jivesoftware.smack.packet.
Registration
Sets the account attributes.
setBody(String)
- Method in class org.jivesoftware.smack.packet.
Message
Sets the body of the message.
setCancelled(boolean)
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a notification sets if the receiver of the message cancelled composing a reply.
setComposing(boolean)
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request sets if the sender of the message requests to be notified when the receiver is composing a reply.
setDelivered(boolean)
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request sets if the sender of the message requests to be notified when the message is delivered.
setDigest(String, String)
- Method in class org.jivesoftware.smack.packet.
Authentication
Sets the digest value using a connection ID and password.
setDigest(String)
- Method in class org.jivesoftware.smack.packet.
Authentication
Sets the digest value directly.
setDisplay(String)
- Method in class org.jivesoftware.smackx.packet.
Time
Sets the local time in human-friendly format.
setDisplayed(boolean)
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request sets if the sender of the message requests to be notified when the message is displayed.
setError(XMPPError)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets the error for this packet.
setFrom(String)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets who the packet is being sent "from".
setInstructions(String)
- Method in class org.jivesoftware.smack.packet.
Registration
Sets the registration instructions.
setItemStatus(RosterPacket.ItemStatus)
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Sets the roster item status.
setItemType(RosterPacket.ItemType)
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Sets the roster item type.
setMode(Presence.Mode)
- Method in class org.jivesoftware.smack.packet.
Presence
Sets the mode of the presence update.
setName(String)
- Method in class org.jivesoftware.smack.
RosterEntry
Sets the name associated with this entry.
setName(String)
- Method in class org.jivesoftware.smack.
RosterGroup
Sets the name of the group.
setName(String)
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
Sets the user's name.
setOffline(boolean)
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
When the message is a request sets if the sender of the message requests to be notified when the receiver of the message is offline.
setPacketID(String)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets the unique ID of the packet.
setPacketID(String)
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Sets the unique ID of the message that requested to be notified of the event.
setPassword(String)
- Method in class org.jivesoftware.smack.packet.
Authentication
Sets the plain text password.
setPassword(String)
- Method in class org.jivesoftware.smack.packet.
Registration
Sets the password.
setPriority(int)
- Method in class org.jivesoftware.smack.packet.
Presence
Sets the priority of the presence.
setPrivateData(PrivateData)
- Method in class org.jivesoftware.smackx.
PrivateDataManager
Sets a private data value.
setProperty(String, int)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets a packet property with an int value.
setProperty(String, long)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets a packet property with a long value.
setProperty(String, float)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets a packet property with a float value.
setProperty(String, double)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets a packet property with a double value.
setProperty(String, boolean)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets a packet property with a bboolean value.
setProperty(String, Object)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets a property with an Object as the value.
setResource(String)
- Method in class org.jivesoftware.smack.packet.
Authentication
Sets the resource.
setStatus(String)
- Method in class org.jivesoftware.smack.packet.
Presence
Sets the status message of the presence update.
setSubject(String)
- Method in class org.jivesoftware.smack.packet.
Message
Sets the subject of the message.
setSubscriptionMode(int)
- Method in class org.jivesoftware.smack.
Roster
Sets the subscription processing mode, which dictates what action Smack will take when subscription requests from other users are made.
setThread(String)
- Method in class org.jivesoftware.smack.packet.
Message
Sets the thread id of the message, which is a unique identifier for a sequence of "chat" messages.
setTime(Date)
- Method in class org.jivesoftware.smackx.packet.
Time
Sets the time using the local time.
setTo(String)
- Method in class org.jivesoftware.smack.packet.
Packet
Sets who the packet is being sent "to".
setType(IQ.Type)
- Method in class org.jivesoftware.smack.packet.
IQ
Sets the type of the IQ packet.
setType(Message.Type)
- Method in class org.jivesoftware.smack.packet.
Message
Sets the type of the message.
setType(Presence.Type)
- Method in class org.jivesoftware.smack.packet.
Presence
Sets the type of the presence packet.
setTz(String)
- Method in class org.jivesoftware.smackx.packet.
Time
Sets the time zone.
setUsername(String)
- Method in class org.jivesoftware.smack.packet.
Authentication
Sets the username.
setUsername(String)
- Method in class org.jivesoftware.smack.packet.
Registration
Sets the username.
setUtc(String)
- Method in class org.jivesoftware.smackx.packet.
Time
Sets the time using UTC formatted String in the format CCYYMMDDThh:mm:ss.
setValue(String, String)
- Method in class org.jivesoftware.smack.packet.
DefaultPacketExtension
Sets a packet extension value using the given name.
setValue(String, String)
- Method in class org.jivesoftware.smackx.packet.
DefaultPrivateData
Sets a value given the name.
supportsAccountCreation()
- Method in class org.jivesoftware.smack.
AccountManager
Returns true if the server supports creating new accounts.
T
TO
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
The user is interested in receiving presence updates from the subscriber.
ThreadFilter
- class org.jivesoftware.smack.filter.
ThreadFilter
.
Filters for message packets with a particular thread value.
ThreadFilter(String)
- Constructor for class org.jivesoftware.smack.filter.
ThreadFilter
Creates a new thread filter using the specified thread value.
Time
- class org.jivesoftware.smackx.packet.
Time
.
A Time IQ packet, which is used by XMPP clients to exchange their respective local times.
Time()
- Constructor for class org.jivesoftware.smackx.packet.
Time
Creates a new Time instance with empty values for all fields.
Time(Calendar)
- Constructor for class org.jivesoftware.smackx.packet.
Time
Cretaes a new Time instance using the specified calendar instance as the time value to send.
ToContainsFilter
- class org.jivesoftware.smack.filter.
ToContainsFilter
.
Filters for packets where the "to" field contains a specified value.
ToContainsFilter(String)
- Constructor for class org.jivesoftware.smack.filter.
ToContainsFilter
Creates a "to" contains filter using the "to" field part.
toString()
- Method in class org.jivesoftware.smack.
RosterEntry
toString()
- Method in class org.jivesoftware.smack.
XMPPException
toString()
- Method in class org.jivesoftware.smack.packet.
IQ.Type
toString()
- Method in class org.jivesoftware.smack.packet.
Message.Type
toString()
- Method in class org.jivesoftware.smack.packet.
Presence.Mode
toString()
- Method in class org.jivesoftware.smack.packet.
Presence.Type
toString()
- Method in class org.jivesoftware.smack.packet.
Presence
toString()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.ItemStatus
toString()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.ItemType
toString()
- Method in class org.jivesoftware.smack.packet.
XMPPError
toString()
- Method in class org.jivesoftware.smackx.
XHTMLText
Returns the text of the XHTMLText.
toXML()
- Method in class org.jivesoftware.smack.packet.
DefaultPacketExtension
toXML()
- Method in class org.jivesoftware.smack.packet.
IQ
toXML()
- Method in class org.jivesoftware.smack.packet.
Message
toXML()
- Method in class org.jivesoftware.smack.packet.
Packet
Returns the packet as XML.
toXML()
- Method in interface org.jivesoftware.smack.packet.
PacketExtension
Returns the XML reppresentation of the PacketExtension.
toXML()
- Method in class org.jivesoftware.smack.packet.
Presence
toXML()
- Method in class org.jivesoftware.smack.packet.
RosterPacket.Item
toXML()
- Method in class org.jivesoftware.smack.packet.
XMPPError
Returns the error as XML.
toXML()
- Method in class org.jivesoftware.smackx.
RemoteRosterEntry
toXML()
- Method in class org.jivesoftware.smackx.packet.
DefaultPrivateData
toXML()
- Method in class org.jivesoftware.smackx.packet.
MessageEvent
Returns the XML representation of a Message Event according the specification.
toXML()
- Method in interface org.jivesoftware.smackx.packet.
PrivateData
Returns the XML reppresentation of the PrivateData.
toXML()
- Method in class org.jivesoftware.smackx.packet.
RosterExchange
Returns the XML representation of a Roster Item Exchange according the specification.
toXML()
- Method in class org.jivesoftware.smackx.packet.
XHTMLExtension
Returns the XML representation of a XHTML extension according the specification.
U
UNAVAILABLE
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
UNSUBCRIPTION_PENDING
- Static variable in class org.jivesoftware.smack.packet.
RosterPacket.ItemStatus
Request to unsubscribe.
UNSUBSCRIBE
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
UNSUBSCRIBED
- Static variable in class org.jivesoftware.smack.packet.
Presence.Type
X
XHTMLExtension
- class org.jivesoftware.smackx.packet.
XHTMLExtension
.
An XHTML sub-packet, which is used by XMPP clients to exchange formatted text.
XHTMLExtension()
- Constructor for class org.jivesoftware.smackx.packet.
XHTMLExtension
XHTMLExtensionProvider
- class org.jivesoftware.smackx.provider.
XHTMLExtensionProvider
.
The XHTMLExtensionProvider parses XHTML packets.
XHTMLExtensionProvider()
- Constructor for class org.jivesoftware.smackx.provider.
XHTMLExtensionProvider
Creates a new XHTMLExtensionProvider.
XHTMLManager
- class org.jivesoftware.smackx.
XHTMLManager
.
Manages XHTML formatted texts within messages.
XHTMLManager()
- Constructor for class org.jivesoftware.smackx.
XHTMLManager
XHTMLText
- class org.jivesoftware.smackx.
XHTMLText
.
An XHTMLText represents formatted text.
XHTMLText(String, String)
- Constructor for class org.jivesoftware.smackx.
XHTMLText
Creates a new XHTMLText with body tag params.
XMPPConnection
- class org.jivesoftware.smack.
XMPPConnection
.
Creates a connection to a XMPP server.
XMPPConnection(String)
- Constructor for class org.jivesoftware.smack.
XMPPConnection
Creates a new connection to the specified XMPP server.
XMPPConnection(String, int)
- Constructor for class org.jivesoftware.smack.
XMPPConnection
Creates a new connection to the to the specified XMPP server on the given port.
XMPPError
- class org.jivesoftware.smack.packet.
XMPPError
.
Represents a XMPP error sub-packet.
XMPPError(int)
- Constructor for class org.jivesoftware.smack.packet.
XMPPError
Creates a new error with the specified code and no message..
XMPPError(int, String)
- Constructor for class org.jivesoftware.smack.packet.
XMPPError
Creates a new error with the specified code and message.
XMPPException
- exception org.jivesoftware.smack.
XMPPException
.
A generic exception that is thrown when an error occurs performing an XMPP operation.
XMPPException()
- Constructor for class org.jivesoftware.smack.
XMPPException
Creates a new XMPPException.
XMPPException(String)
- Constructor for class org.jivesoftware.smack.
XMPPException
Creates a new XMPPException with a description of the exception.
XMPPException(Throwable)
- Constructor for class org.jivesoftware.smack.
XMPPException
Creates a new XMPPException with the Throwable that was the root cause of the exception.
XMPPException(XMPPError)
- Constructor for class org.jivesoftware.smack.
XMPPException
Cretaes a new XMPPException with the XMPPError that was the root case of the exception.
XMPPException(String, Throwable)
- Constructor for class org.jivesoftware.smack.
XMPPException
Creates a new XMPPException with a description of the exception and the Throwable that was the root cause of the exception.
XMPPException(String, XMPPError, Throwable)
- Constructor for class org.jivesoftware.smack.
XMPPException
Creates a new XMPPException with a description of the exception, an XMPPError, and the Throwable that was the root cause of the exception.
XMPPException(String, XMPPError)
- Constructor for class org.jivesoftware.smack.
XMPPException
Creates a new XMPPException with a description of the exception and the XMPPException that was the root cause of the exception.
A
B
C
D
E
F
G
H
I
J
L
M
N
O
P
R
S
T
U
X
Overview
Package
Class
Tree
Deprecated
Index
Help
Smack
PREV NEXT
FRAMES
NO FRAMES
All Classes
Copyright © 2003 Jive Software.