org.jivesoftware.smackx.address

Class MultipleRecipientInfo

java.lang.Object

org.jivesoftware.smackx.address.MultipleRecipientInfo

public class MultipleRecipientInfo
extends Object

MultipleRecipientInfo keeps information about the multiple recipients extension included in a received packet. Among the information we can find the list of TO and CC addresses.

Author:

Gaston Dombiak

Method Summary

Modifier and Type	Method and Description
List<MultipleAddresses.Address>	getCCAddresses() Returns the list of MultipleAddresses.Address that were the secondary recipients of the packet.
MultipleAddresses.Address	getReplyAddress() Returns the address to which all replies are requested to be sent or null if no specific address was provided.
String	getReplyRoom() Returns the JID of a MUC room to which responses should be sent or null if no specific address was provided.
List<MultipleAddresses.Address>	getTOAddresses() Returns the list of MultipleAddresses.Address that were the primary recipients of the packet.
boolean	shouldNotReply() Returns true if the received stanza(/packet) should not be replied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTOAddresses

public List<MultipleAddresses.Address> getTOAddresses()

Returns the list of MultipleAddresses.Address that were the primary recipients of the packet.

Returns:

list of primary recipients of the packet.

getCCAddresses

public List<MultipleAddresses.Address> getCCAddresses()

Returns the list of MultipleAddresses.Address that were the secondary recipients of the packet.

Returns:

list of secondary recipients of the packet.

getReplyRoom

public String getReplyRoom()

Returns the JID of a MUC room to which responses should be sent or null if no specific address was provided. When no specific address was provided then the reply can be sent to any or all recipients. Otherwise, the user should join the specified room and send the reply to the room.

Returns:

the JID of a MUC room to which responses should be sent or null if no specific address was provided.

shouldNotReply

public boolean shouldNotReply()

Returns true if the received stanza(/packet) should not be replied. Use MultipleRecipientManager.reply(org.jivesoftware.smack.XMPPConnection, org.jivesoftware.smack.packet.Message, org.jivesoftware.smack.packet.Message) to send replies.

Returns:

true if the received stanza(/packet) should not be replied.

getReplyAddress

public MultipleAddresses.Address getReplyAddress()

Returns the address to which all replies are requested to be sent or null if no specific address was provided. When no specific address was provided then the reply can be sent to any or all recipients.

Returns:

the address to which all replies are requested to be sent or null if no specific address was provided.