org.elastos.carrier

Class Group

java.lang.Object

org.elastos.carrier.Group

public class Group
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.PeerInfo A class representing group peer information.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_APP_MESSAGE_LEN Carrier App message max length.
static int	MAX_GROUP_TITLE_LEN Max Carrier group title length.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId()
Group.PeerInfo	getPeer(java.lang.String peerId) Get group peer information.
java.util.List<Group.PeerInfo>	getPeers() Get group peer list.
java.lang.String	getTitle() Get group title.
void	invite(java.lang.String friendId) Invite a specified friend into group.
void	sendMessage(byte[] message) Send a message to a group.
void	setTitle(java.lang.String title) Set group title.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_APP_MESSAGE_LEN

public static final int MAX_APP_MESSAGE_LEN

Carrier App message max length.

See Also:

Constant Field Values

MAX_GROUP_TITLE_LEN

public static final int MAX_GROUP_TITLE_LEN

Max Carrier group title length.

See Also:

Constant Field Values

Method Detail

getId

public java.lang.String getId()

invite

public void invite(java.lang.String friendId)
            throws CarrierException

Invite a specified friend into group.

Parameters:

friendId - The invited friendId

Throws:

java.lang.IllegalArgumentException - illegal exception.

CarrierException - carrier exception.

sendMessage

public void sendMessage(byte[] message)
                 throws CarrierException

Send a message to a group. The message length may not exceed MAX_APP_MESSAGE_LEN. Larger messages must be split by application and sent as separate fragments. Other carrier nodes can reassemble the fragments. Message may not be empty or null.

Parameters:

message - The message content defined by application

Throws:

java.lang.IllegalArgumentException - illegal exception.

CarrierException - carrier exception.

getTitle

public java.lang.String getTitle()
                          throws CarrierException

Get group title.

Returns:

The title of the specified group

Throws:

CarrierException - carrier exception.

setTitle

public void setTitle(java.lang.String title)
              throws CarrierException

Set group title.

Parameters:

title - The title name to set(should be no longer than MAX_GROUP_TITLE_LEN)

Throws:

java.lang.IllegalArgumentException - illegal exception.

CarrierException - carrier exception.

getPeers

public java.util.List<Group.PeerInfo> getPeers()
                                        throws CarrierException

Get group peer list.

Returns:

A list of all peers in the specified group

Throws:

CarrierException - carrier exception.

getPeer

public Group.PeerInfo getPeer(java.lang.String peerId)
                       throws CarrierException

Get group peer information.

Parameters:

peerId - The target peerId to get it's information

Returns:

Information of the specified peer

Throws:

java.lang.IllegalArgumentException - illegal exception.

CarrierException - carrier exception.