YsfService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.ysf;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.msg.MessageBuilder;
import com.netease.nimlib.sdk.msg.MsgServiceObserve;
import com.netease.nimlib.sdk.msg.attachment.MsgAttachmentParser;
import com.netease.nimlib.sdk.msg.model.CustomNotification;
import com.netease.nimlib.sdk.msg.model.IMMessage;

/**
 * Created by hzsunyj on 2019-05-16.
 */
@NIMService("云商服服务")
public interface YsfService {

    /**
     * 发送消息。<br>
     * 如果需要更新发送进度，请调用{@link MsgServiceObserve#observeMsgStatus(com.netease.nimlib.sdk.Observer, boolean)}
     *
     * @param msg    带发送的消息体，由{@link MessageBuilder}构造
     * @param resend 如果是发送失败后重发，标记为true，否则填false
     * @return InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。
     */
    InvocationFuture<Void> sendMessage(IMMessage msg, boolean resend);

    /**
     * 发送一条指令消息。<br>
     * 由于SDK仅负责透传该消息，因此不会记录指令消息状态，但可以设置回调函数监听发送结果。
     *
     * @param notification 指令消息
     * @return InvocationFuture 可设置回调函数，监听发送结果。
     */
    InvocationFuture<Void> sendCustomNotification(CustomNotification notification);

    /**
     * 更新消息记录的状态。可更新：<br>
     * 消息状态 {@link IMMessage#getStatus()} 不为 null 时更新<br>
     * 附件状态 {@link IMMessage#getAttachStatus()} 不为 null 时更新<br>
     * 附件内容 {@link IMMessage#getAttachment()} 不为 null 时更新
     *
     * @param message 待更新的消息记录
     * @param notify  更新之后是否要通知UI更新界面
     */
    void updateIMMessageStatus(IMMessage message, boolean notify);

    /**
     * 更新消息，将原始消息替换掉
     *
     * @param msg    待更新的消息体，由{@link MessageBuilder}构造
     * @param notify 更新之后是否要通知UI更新界面
     */
    void updateMessage(IMMessage msg, boolean notify);

    /**
     * 如果第三方app需要自定义的附件消息类型，再次注册自己的附件解析器。<br>
     * 客户自定义的消息类型为{@link com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#custom} <br>
     * 自定义附件类型须继承自MsgAttachment。
     * @param type 消息类型
     * @param customParser 附件解析器
     */
    void registerAttachmentParser(int type, MsgAttachmentParser customParser);

    /**
     * 保存消息到本地数据库，但不发送到服务器端。用于第三方APP保存本地提醒一类的消息。<br>
     * 该接口将消息保存到数据库后，如果需要通知到UI，可将notify设置为true，此时会触发{@link MsgServiceObserve#observeReceiveMessage(Observer, boolean)}通知。
     *
     * @param msg    待保存的消息对象
     * @param notify 是否要通知UI更新界面
     * @return InvocationFuture 可以设置回调函数。在消息存入数据库后,就会回调。
     */
    InvocationFuture<Void> saveMessageToLocal(IMMessage msg, boolean notify);

}