com.netease.nimlib.sdk.msg

Interface SystemMessageService

public interface SystemMessageService

System message service interface
Handle system messages, such as group request and group invitation

Method Summary

Modifier and Type	Method and Description
void	clearSystemMessages() Delete all system messages
void	clearSystemMessagesByType(java.util.List<SystemMessageType> types) Delete system messages of a specified type
void	deleteSystemMessage(long messageId) Delete a system message
InvocationFuture<java.util.List<SystemMessage>>	querySystemMessageByType(java.util.List<SystemMessageType> types, int offset, int limit) Query system messages by type (async)
java.util.List<SystemMessage>	querySystemMessageByTypeBlock(java.util.List<SystemMessageType> types, int offset, int limit) Query system messages by type (sync)
InvocationFuture<java.util.List<SystemMessage>>	querySystemMessages(int offset, int limit) Query system messages (async)
java.util.List<SystemMessage>	querySystemMessagesBlock(int offset, int limit) Query system messages (sync)
InvocationFuture<java.util.List<SystemMessage>>	querySystemMessageUnread() Get all unread system messages
InvocationFuture<java.lang.Integer>	querySystemMessageUnreadCount() Deprecated. Use the sync version querySystemMessageUnreadCountBlock() for less overhead and UI will not blocked.
int	querySystemMessageUnreadCountBlock() Query the number of unread system messages (sync)
int	querySystemMessageUnreadCountByType(java.util.List<SystemMessageType> types) Query the number of unread system messages of a specified type (sync)
void	resetSystemMessageUnreadCount() Set all system messages to read and reset the number of the unread system messages to 0.
void	resetSystemMessageUnreadCountByType(java.util.List<SystemMessageType> types) Set system messages of a specified type to read
void	setSystemMessageRead(long messageId) Set a system message to read
void	setSystemMessageStatus(long messageId, SystemMessageStatus status) Set the state of system messages After system messages are handled, the method can be called to update the state of system messages.

Method Detail

querySystemMessages

InvocationFuture<java.util.List<SystemMessage>> querySystemMessages(int offset,
                                                                    int limit)

Query system messages (async)

Parameters:

offset - The offset for query in database

limit - The limit for query in database

Returns:

InvocationFuture, configurable callback. The parameter is system messages.

querySystemMessagesBlock

java.util.List<SystemMessage> querySystemMessagesBlock(int offset,
                                                       int limit)

Query system messages (sync)

Parameters:

offset - The offset for query in database

limit - The limit for query in database

Returns:

System messages

querySystemMessageByType

InvocationFuture<java.util.List<SystemMessage>> querySystemMessageByType(java.util.List<SystemMessageType> types,
                                                                         int offset,
                                                                         int limit)

Query system messages by type (async)

Parameters:

types - Message types to be queried

offset - The offset for query in database

limit - The limit for query in database

Returns:

InvocationFuture, Configurable callback function. The parameter is specified types of system messages.

querySystemMessageByTypeBlock

java.util.List<SystemMessage> querySystemMessageByTypeBlock(java.util.List<SystemMessageType> types,
                                                            int offset,
                                                            int limit)

Query system messages by type (sync)

Parameters:

types - Message types to be queried

offset - The offset for query in database

limit - The limit for query in database

Returns:

specified types of system messages

querySystemMessageUnread

InvocationFuture<java.util.List<SystemMessage>> querySystemMessageUnread()

Get all unread system messages

Returns:

InvocationFuture, Configurable callback function. The parameter is all unread system messages.

setSystemMessageStatus

void setSystemMessageStatus(long messageId,
                            SystemMessageStatus status)

Set the state of system messages After system messages are handled, the method can be called to update the state of system messages.

Parameters:

messageId - Message ID

status - Status to be updated

deleteSystemMessage

void deleteSystemMessage(long messageId)

Delete a system message

Parameters:

messageId - Specified system message ID

clearSystemMessages

void clearSystemMessages()

Delete all system messages

clearSystemMessagesByType

void clearSystemMessagesByType(java.util.List<SystemMessageType> types)

Delete system messages of a specified type

Parameters:

types - Types of system messages

querySystemMessageUnreadCount

InvocationFuture<java.lang.Integer> querySystemMessageUnreadCount()

Deprecated. Use the sync version querySystemMessageUnreadCountBlock() for less overhead and UI will not blocked.

Query the number of unread system messages (async)

Returns:

InvocationFuture, configurable callback. The parameter is the unread count of system messages.

querySystemMessageUnreadCountBlock

int querySystemMessageUnreadCountBlock()

Query the number of unread system messages (sync)

Returns:

The number of all unread system messages

querySystemMessageUnreadCountByType

int querySystemMessageUnreadCountByType(java.util.List<SystemMessageType> types)

Query the number of unread system messages of a specified type (sync)

Parameters:

types - Types of system messages

Returns:

the number of unread system messages of a specified type

resetSystemMessageUnreadCount

void resetSystemMessageUnreadCount()

Set all system messages to read and reset the number of the unread system messages to 0.

resetSystemMessageUnreadCountByType

void resetSystemMessageUnreadCountByType(java.util.List<SystemMessageType> types)

Set system messages of a specified type to read

Parameters:

types - Types of system messages

setSystemMessageRead

void setSystemMessageRead(long messageId)

Set a system message to read

Parameters:

messageId - Message ID