|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Conference is an instant messaging session between 2 or more users.
Field Summary | |
static int |
INVITE
ability to invite a non-member to become a member to a chat room. |
static int |
LISTEN
The LISTEN operation is the ability to join the chat room as a passive user. |
static int |
MANAGE
the MANAGE operation set includes shutting down the conference or bulletin board, or modify other members' access right to this conference or bulletin board. |
static int |
NONE
No rights. |
static int |
PUBLISH
ability to send messages |
static int |
STATUS_APPROVED
A status indicating that the message was approved by the moderator |
static int |
STATUS_MODIFIED
A status indicating that the message was modified by the moderator |
static int |
STATUS_PENDING
A status indicating that the message was pending for moderation |
static int |
STATUS_REJECTED
A status indicating that the message was rejected by the moderator |
static int |
STATUS_SUBMIT
A status indicating that the message was submitted for moderation |
Method Summary | |
void |
addMessage(Message message)
add a message, which will be received by other parties in the conference. |
void |
addModeratedMessage(Message message,
int status,
java.lang.String reason)
This method should be used submit and approve moderated messages. |
void |
close()
terminates the conference This will have the effect of destroying all currently archived messages (for a bulletin board) and unsubscribing all current subscribe members. |
InviteMessage |
createInviteMessage()
create an invite message |
Message |
createMessage()
create a new message |
int |
getDefaultPrivilege()
return the conference's default access level |
java.lang.String |
getDestination()
returns the conference's address. |
java.util.Collection |
getParticipants()
Lists the participants in the room. |
int |
getPrivilege()
return the current user's access level |
int |
getPrivilege(java.lang.String uid)
|
java.lang.String |
getProperty(java.lang.String attribute)
get a conference property |
boolean |
hasPrivilege(int accessLevel)
checks if the user has the required privilege for this conference. |
void |
invite(int accessLevel,
Message message,
InviteMessageStatusListener listener)
invite another user to this conference. |
boolean |
isPublic()
Tells whether this conference is public or persistent. |
void |
join(ConferenceListener listener)
invoked by the application to specify that the user accepts the conference and to pass the conference listener. |
void |
leave()
leave the conference. |
java.util.Map |
listPrivileges()
get the privileges of the all the users affiliated with the bulletin board |
void |
moderate(boolean start)
Start or stop the moderation |
void |
setDefaultPrivilege(int accessLevel)
set the default access level for members, unless specified otherwise. |
void |
setPrivilege(java.lang.String uid,
int accessLevel)
set a principal's privilege for this conference. |
void |
setPrivileges(java.util.Map map)
sets the privleges of the users to the conference on the server |
void |
setProperty(java.lang.String attribute,
java.lang.String value)
set a conference property |
Field Detail |
public static final int NONE
public static final int LISTEN
public static final int PUBLISH
public static final int INVITE
public static final int MANAGE
public static final int STATUS_SUBMIT
public static final int STATUS_PENDING
public static final int STATUS_APPROVED
public static final int STATUS_MODIFIED
public static final int STATUS_REJECTED
Method Detail |
public java.lang.String getDestination()
public void addMessage(Message message) throws CollaborationException
message
- message
CollaborationException
public void addModeratedMessage(Message message, int status, java.lang.String reason) throws CollaborationException
message
- Message to be submitted for moderation by users with a LISTEN access or
The modified message after approval by the moderator. If there was no modification
to the message then it should be same as the original message received.status
- - The status of the message as defined in Conference.reason
- - The comments on the moderated message.While submitting the message the reason may be ignored.
CollaborationException
public void leave()
public void join(ConferenceListener listener) throws CollaborationException
listener
- conference handler
CollaborationException
public Message createMessage() throws CollaborationException
CollaborationException
public InviteMessage createInviteMessage() throws CollaborationException
CollaborationException
public void invite(int accessLevel, Message message, InviteMessageStatusListener listener) throws CollaborationException
accessLevel
- privilege to assign to the invitee,
if different from the conference's
default. It may not exceed the caller's access level.message
- invite message. The list of invitees is
provided as the list of receipients for the invite messagelistener
- status listener for the invite
CollaborationException
public java.util.Map listPrivileges() throws CollaborationException
CollaborationException
public void setPrivileges(java.util.Map map) throws CollaborationException
CollaborationException
public int getPrivilege() throws CollaborationException
CollaborationException
Conference
public int getPrivilege(java.lang.String uid) throws CollaborationException
uid
- fully-qualified principal identifier
return the specified principal's access level
CollaborationException
public void setPrivilege(java.lang.String uid, int accessLevel) throws CollaborationException
accessLevel
- access level to set for this principaluid
- fully-qualified principal identifier
CollaborationException
public boolean hasPrivilege(int accessLevel) throws CollaborationException
accessLevel
- access level to set for this principal
CollaborationException
public void setDefaultPrivilege(int accessLevel) throws CollaborationException
accessLevel
- access level
CollaborationException
public int getDefaultPrivilege() throws CollaborationException
CollaborationException
public void close() throws CollaborationException
CollaborationException
public java.lang.String getProperty(java.lang.String attribute)
attribute
- property name
public void setProperty(java.lang.String attribute, java.lang.String value) throws CollaborationException
attribute
- property namevalue
- property value
CollaborationException
public void moderate(boolean start) throws CollaborationException
start
- true if moderations is to be started
CollaborationException
public boolean isPublic()
public java.util.Collection getParticipants() throws CollaborationException
CollaborationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |