com.netease.nimlib.sdk.msg.model

Class SystemMessage

java.lang.Object

com.netease.nimlib.sdk.msg.model.SystemMessage

All Implemented Interfaces:

java.io.Serializable

public class SystemMessage
extends java.lang.Object
implements java.io.Serializable

System message schema

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SystemMessage()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttach() Get the attachment of a system message.
java.lang.Object	getAttachObject() Get the parsed attachment object of a system message.
java.lang.String	getContent() Get the content of a system message For example, An extra info for a join request or reason for decline
java.lang.String	getCustomInfo() Get the custom information.
java.lang.String	getFromAccount() Get the account that initiates the system message.
long	getMessageId() Get the ID of a system message
SystemMessageStatus	getStatus() Get the status of a system message
java.lang.String	getTargetId() Get the target ID of a system message For example, the group ID that declined the join request
long	getTime() Get the time when a system message is sent in milliseconds
SystemMessageType	getType() Get the type of a system message
boolean	isUnread() Check if a system message is read
void	setAttach(java.lang.String attach) Set the attachment of a system message.
void	setAttachObject(java.lang.Object object) Set the attachment object after parsing The field is separate from the attach field.
void	setContent(java.lang.String content) Set the content of a system message
void	setFromAccount(java.lang.String fromAccount) Set the account of an initiator
void	setMessageId(long messageId) Set the ID of a system message
void	setStatus(SystemMessageStatus status) Set the status of a system message
void	setTargetId(java.lang.String targetId) Set the target ID of a system message
void	setTime(long time) Set the time when a system message is sent
void	setType(int type) Set the type of a system message
void	setUnread(boolean unread) Set the unread indicator for system messages

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemMessage

public SystemMessage()

Method Detail

getMessageId

public long getMessageId()

Get the ID of a system message

Returns:

message ID

setMessageId

public void setMessageId(long messageId)

Set the ID of a system message

Parameters:

messageId - message ID

getType

public SystemMessageType getType()

Get the type of a system message

Returns:

type of a system message

setType

public void setType(int type)

Set the type of a system message

Parameters:

type - System message type

getFromAccount

public java.lang.String getFromAccount()

Get the account that initiates the system message.
For example, an applicant that sends a group join request. The user that accepts the invitation.

Returns:

The account that triggers the system message

setFromAccount

public void setFromAccount(java.lang.String fromAccount)

Set the account of an initiator

Parameters:

fromAccount - the account of an initiator

getTargetId

public java.lang.String getTargetId()

Get the target ID of a system message For example, the group ID that declined the join request

Returns:

target ID

setTargetId

public void setTargetId(java.lang.String targetId)

Set the target ID of a system message

Parameters:

targetId - target ID

getTime

public long getTime()

Get the time when a system message is sent in milliseconds

Returns:

The time

setTime

public void setTime(long time)

Set the time when a system message is sent

Parameters:

time - The time

getStatus

public SystemMessageStatus getStatus()

Get the status of a system message

Returns:

status

setStatus

public void setStatus(SystemMessageStatus status)

Set the status of a system message

Parameters:

status - the status

getContent

public java.lang.String getContent()

Get the content of a system message
For example, An extra info for a join request or reason for decline

Returns:

Content

setContent

public void setContent(java.lang.String content)

Set the content of a system message

Parameters:

content - The content

getAttach

public java.lang.String getAttach()

Get the attachment of a system message.
The field is reserved

Returns:

Attachment

setAttach

public void setAttach(java.lang.String attach)

Set the attachment of a system message.

Parameters:

attach - The attachment

getAttachObject

public java.lang.Object getAttachObject()

Get the parsed attachment object of a system message.
Third-party apps can parse custom message types.
For information about the definition of the returns for built-in system messages, see SystemMessageType

Returns:

Attachment object

setAttachObject

public void setAttachObject(java.lang.Object object)

Set the attachment object after parsing
The field is separate from the attach field. This allows third-party apps to store custom attachment object.

Parameters:

object - The attachment object

isUnread

public boolean isUnread()

Check if a system message is read

Returns:

true: unread; false: read

setUnread

public void setUnread(boolean unread)

Set the unread indicator for system messages

Parameters:

unread - true: unread; false: read

getCustomInfo

public java.lang.String getCustomInfo()

Get the custom information. The custom information is applied for sending invitations to join a group.

Returns:

customInfo