public interface Room
Modifier and Type | Interface and Description |
---|---|
static class |
Room.InheritanceType |
Modifier and Type | Method and Description |
---|---|
Room |
add(java.lang.String email)
Add a participant to the room.
|
Room |
addParam(java.lang.String param,
java.lang.String value)
Attach a parameter to the room
|
Room |
addParam(java.lang.String param,
java.lang.String value,
Room.InheritanceType type,
java.lang.Object extra)
Attach a parameter to the room
|
Room |
addRelation(java.lang.String relation,
Room roomwith)
For future use
|
Room |
comment(Comment comment)
Post a comment to a chatlet in a room.
|
java.lang.String |
getId() |
java.lang.String |
getName()
Gets name of the room used for display purpose
|
Room |
inheritParams(Room fromRoom) |
java.lang.String |
param(java.lang.String param) |
Room |
post(Chatlet chatlet)
Post a (new) chatlet in a room.
|
Room |
registerForEvents()
After calling this method, events in this room
will go to the method annotated with @OnEventInRegisteredRoom
|
Room |
remove(java.lang.String email)
Remove a participant from the room.
|
Room |
reply(Reply reply)
Post a reply to a chatlet in a room.
|
Room |
setName(java.lang.String name)
Assign a name to the room used for display purpose
|
Room |
welcome(java.lang.String msg)
Set the welcome msg if this is new room.
|
Room setName(java.lang.String name)
name
- The name of the room.java.lang.String getName()
Room add(java.lang.String email)
email
- The email id of the participant to be added.Room remove(java.lang.String email)
email
- The email of the participant to be removed.Room post(Chatlet chatlet)
chatlet
- The chatlet to be posted.Room reply(Reply reply)
reply
- The reply to be posted.Room comment(Comment comment)
comment
- The comment to be posted.Room welcome(java.lang.String msg)
msg
- The msg to be set as welcome msgRoom registerForEvents()
Room inheritParams(Room fromRoom)
fromRoom
- the room from which to inherit the parametersRoom addParam(java.lang.String param, java.lang.String value)
param
- The name of the parameter to attachvalue
- The value of the parameter to attachRoom addParam(java.lang.String param, java.lang.String value, Room.InheritanceType type, java.lang.Object extra)
param
- The name of the parameter to attachvalue
- The value of the parameter to attachjava.lang.String param(java.lang.String param)
java.lang.String getId()