|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Role public interface MessageStream
The message stream allows to post and retrieve short messages, from one user to one of a few possible targets: direct private messages to another user, messages to a group of users, personal messages to all the users that "follow" the sender.
Method Summary | |
---|---|
void |
deleteMessage(String id)
Delete an existing message, identified by its unique ID, if the current user is the author of that message. |
List<Event> |
getRecentDirectMessages()
Get the 30 most recent direct messages sent to the current user. |
List<Event> |
getRecentDirectMessages(int limit,
int offset)
Get the most recent direct messages sent to the current user, at most limit , and skipping the first
offset . |
List<Event> |
getRecentMessagesForGroup(DocumentReference group)
Get the 30 most recent messages sent to the specified group. |
List<Event> |
getRecentMessagesForGroup(DocumentReference group,
int limit,
int offset)
Get the most recent messages sent to the specified group, at most limit , and skipping the first offset . |
List<Event> |
getRecentPersonalMessages()
Get the 30 most recent messages posted by the current user. |
List<Event> |
getRecentPersonalMessages(DocumentReference author)
Get the 30 most recent personal messages posted by the specified user. |
List<Event> |
getRecentPersonalMessages(DocumentReference author,
int limit,
int offset)
Get the most recent direct messages sent to the current user, at most limit , and skipping the first
offset . |
List<Event> |
getRecentPersonalMessages(int limit,
int offset)
Get the most recent messages posted by the current user, at most limit , and skipping the first offset . |
void |
postDirectMessageToUser(String message,
DocumentReference user)
Post a private message to another user. |
void |
postMessageToGroup(String message,
DocumentReference group)
Post a message to a specific group of users. |
void |
postPersonalMessage(String message)
Post a message to the current user's personal stream, displayed on his profile page and aggregated into their follower's streams. |
void |
postPublicMessage(String message)
Post a message to the current user's stream, visible to everyone. |
Method Detail |
---|
void postPublicMessage(String message)
message
- the message to storevoid postPersonalMessage(String message)
message
- the message to storeList<Event> getRecentPersonalMessages()
List<Event> getRecentPersonalMessages(int limit, int offset)
limit
, and skipping the first offset
.
limit
- the maximum number of messages to returnoffset
- how many messages to skip
List<Event> getRecentPersonalMessages(DocumentReference author)
author
- the user that wrote the messages
List<Event> getRecentPersonalMessages(DocumentReference author, int limit, int offset)
limit
, and skipping the first
offset
.
author
- the user that wrote the messageslimit
- the maximum number of messages to returnoffset
- how many messages to skip
void postDirectMessageToUser(String message, DocumentReference user)
message
- the message to senduser
- the target userList<Event> getRecentDirectMessages()
List<Event> getRecentDirectMessages(int limit, int offset)
limit
, and skipping the first
offset
.
limit
- the maximum number of messages to returnoffset
- how many messages to skip
void postMessageToGroup(String message, DocumentReference group)
message
- the message to sendgroup
- the target groupList<Event> getRecentMessagesForGroup(DocumentReference group)
group
- the target group for which to retrieve messages
List<Event> getRecentMessagesForGroup(DocumentReference group, int limit, int offset)
limit
, and skipping the first offset
.
group
- the target group for which to retrieve messageslimit
- the maximum number of messages to returnoffset
- how many messages to skip
void deleteMessage(String id)
id
- the unique ID of the message
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |