com.netease.nimlib.sdk.ysf

Interface YsfService

public interface YsfService

Method Summary

Modifier and Type	Method and Description
void	registerAttachmentParser(int type, MsgAttachmentParser customParser) If third party apps require custom message types with attachments, the attachment parser must also be registered.
InvocationFuture<java.lang.Void>	saveMessageToLocal(IMMessage msg, boolean notify) Store the message to the local database instead of server side.
InvocationFuture<java.lang.Void>	sendCustomNotification(CustomNotification notification) Send an instruction message.
InvocationFuture<java.lang.Void>	sendMessage(IMMessage msg, boolean resend) send messages. To update the progress, call MsgServiceObserve.observeMsgStatus(com.netease.nimlib.sdk.Observer, boolean)
void	updateIMMessageStatus(IMMessage message, boolean notify) Update message status.
void	updateMessage(IMMessage msg, boolean notify) Update the message and replace the original message

Method Detail

sendMessage

InvocationFuture<java.lang.Void> sendMessage(IMMessage msg,
                                             boolean resend)

send messages.
To update the progress, call MsgServiceObserve.observeMsgStatus(com.netease.nimlib.sdk.Observer, boolean)

Parameters:

msg - Message constructed by MessageBuilder

resend - resend a message if sending failed, true: resend message. Otherwise, false

Returns:

InvocationFuture callback. When a message is sent, the callback will be triggered. If an error occurs, a specific error code is returned.

sendCustomNotification

InvocationFuture<java.lang.Void> sendCustomNotification(CustomNotification notification)

Send an instruction message.
The SDK send the message in transparent transmission mode, the instruction message status is not recorded. However, a callback can be set to observe the result of the operation.

Parameters:

notification - The instruction message

Returns:

InvocationFuture callback that observe the result.

updateIMMessageStatus

void updateIMMessageStatus(IMMessage message,
                           boolean notify)

Update message status. The items to be updated:
Messages status IMMessage.getStatus(). Update the status if null is not set
Attachment status IMMessage.getAttachStatus(). Update the status if null is not set
Attachment content IMMessage.getAttachment(). Update the status if null is not set

Parameters:

message - Message to be updated

notify - specify whether to update the UI view for the message.

updateMessage

void updateMessage(IMMessage msg,
                   boolean notify)

Update the message and replace the original message

Parameters:

msg - message body constructed by MessageBuilder

notify - specify whether to update the UI view for the message.

registerAttachmentParser

void registerAttachmentParser(int type,
                              MsgAttachmentParser customParser)

If third party apps require custom message types with attachments, the attachment parser must also be registered.
Custom message type is MsgTypeEnum.custom
the attachment of a custom message must inherit MsgAttachment。

Parameters:

type - message type

customParser - Attachment parser

saveMessageToLocal

InvocationFuture<java.lang.Void> saveMessageToLocal(IMMessage msg,
                                                    boolean notify)

Store the message to the local database instead of server side. Used to store local alert for third-party apps.
Store the message to the database. If the message needs to be notified on a UI view, set notify to true and MsgServiceObserve.observeReceiveMessage(Observer, boolean) will be triggered.

Parameters:

msg - Message to be saved

notify - Specify whether to update the UI view for the message

Returns:

InvocationFuture can set a callback function. The callback is triggered when the message is saved to the database.