消息与卡片

public static final IMMessage buildTextMessage(String sessionId, String text)

public static final IMMessage buildImageMessage(String sessionId, File file, String displayName)

public static final IMMessage buildVideoMessage(File file, long duration, int width, int height, String displayName)
public static final IMMessage buildVideoMessage(String sessionId, File file, long duration, int width, int height, String displayName)

public static IMMessage buildFileMessage(String sessionId, String filePath)
public static IMMessage buildFileMessage(String sessionId, Uri uri)

IMMessage message = UnicornMessageBuilder.buildTextMessage(UnicornMessageBuilder.getSessionId(), "文本消息");

// 标准版
String sessionId = UnicornMessageBuilder.getSessionId();
IMMessage message = UnicornMessageBuilder.buildTextMessage(sessionId, "文本消息");
MessageService.sendMessage(message);

// 平台版
String sessionId = shopId;
IMMessage platformMessage = UnicornMessageBuilder.buildTextMessage(sessionId, "文本消息");
MessageService.sendMessage(platformMessage);

public static void sendMessage(IMMessage message)

public static void saveMessageToLocal(IMMessage message, boolean isNotify, boolean isSaveDB)

/**
 * 第一步实现自己的 MsgAttachment
 */
public class DemoAttachment implements MsgAttachment{

    public static final String TAG_STRING = "tag_string";
    public static final String TAG_URL = "tag_url";

    private String msgContent;

    private String imgUrl;

    public String getImgUrl() {
        return imgUrl;
    }

    public void setImgUrl(String imgUrl) {
        this.imgUrl = imgUrl;
    }

    public String getMsgContent() {
        return msgContent;
    }

    public void setMsgContent(String msgContent) {
        this.msgContent = msgContent;
    }

    //这个方法必须重写，因为在存入数据库的时候需要用到
    @Override
    public String toJson(boolean send) {
        JSONObject jsonObject = new JSONObject();
        try {
            jsonObject.put(TAG_STRING,getMsgContent());
            jsonObject.put(TAG_URL,getImgUrl());
        } catch (JSONException e) {
            //log
        }
        return jsonObject.toString();
    }

    @Override
    public boolean countToUnread() {
        return false;
    }

    @Override
    public String getContent(Context context) {
        return msgContent;
    }
}

/**
 * 第二步实现自己的 UnicornMessageViewHolder
 */
public class DemoCustomViewHolder extends UnicornMessageViewHolder{

    private TextView tvViewHolderDemoText;
    private TextView tvViewHolderDemoUrl;

    @Override
    public int getViewHolderResid() {
        return R.layout.viewholder_demo_custom;
    }

    @Override
    public void inflateFindView() {
        tvViewHolderDemoText = findViewById(R.id.tv_view_holder_demo_text);
        tvViewHolderDemoUrl = findViewById(R.id.tv_view_holder_demo_url);

    }

    @Override
    public void bindContentView(IMMessage message, Context context) {
        DemoAttachment attachment = (DemoAttachment) message.getAttachment();
        tvViewHolderDemoText.setText(attachment.getMsgContent());
        tvViewHolderDemoUrl.setText(attachment.getImgUrl());
        progressBar.setVisibility(View.GONE);
    }

    @Override
    protected boolean isMiddleItem() {
        return true;
    }

    @Override
    protected boolean showAvatar() {
        return false;
    }
}

/**
 * 第三步请见上文所述的拦截 SDK 事件一节
 */

/**
 * 第四步注册 Attachment 和 ViewHolder 的关系
 * 该步可以在任何地方调用，但切记在发送自定义消息之前
 */
MsgCustomizationRegistry.registerMessageViewHolder(DemoAttachment.class, DemoCustomViewHolder.class);

/**
 * 第五步创建消息并保存消息到本地
 */
IMMessage message = UnicornMessageBuilder.buildAppCustomMessage(attachment);
//具体参数请查看 MessageService 类的说明
MessageService.saveMessageToLocal(message, true, true);

public static void sendProductMessage(ProductDetail productDetail)
public static void sendProductMessage(String shopId, ProductDetail productDetail)

ProductDetail.Tag tag = new ProductDetail.Tag();
tag.setLabel("label");
tag.setUrl("http://qiyukf.com/");
ArrayList<ProductDetail.Tag> list = new ArrayList<>();
list.add(tag);
ProductDetail productDetail = new ProductDetail.Builder()
        .setTitle("标题")
        .setDesc("描述")
        .setPicture("https://p9.itc.cn/images01/20230323/5ca2619b1743433ca9cd3e435edc455d.png")
        .setUrl("http://qiyukf.com/")
        .setNote("备注")
        .setShow(1)
        .setTags(list)
        .setGoodsCId("商品类目ID")
        .setGoodsCName("商品类目名称")
        .setCardType(0)
        .setGoodsId("aaa")
        .build();

ConsultSource source = new ConsultSource("goods_detail", "商品详情", null);
source.productDetail = productDetail;
Unicorn.openServiceActivity(context, "商品咨询", source);

MessageService.sendProductMessage(productDetail);

// 平台版
MessageService.sendProductMessage(shopId, productDetail);

{
	"productCustomField":"2342342342342342",
	"isOpenCustomProduct":true,
	"sendByUser":1,
	"actionText":"fasonglianjiessz",
	"actionTextColor":"#FF1493",
	"template":"pictureLink",
	"picture": "https://ysf.nosdn.127.net/32FD7DAACD42CE79DD03B1B82F690B7B?imageView&type=png",
	"title": "[自营]Orange Juice",
	"desc": "Relish the goodness of hand-picked oranges from the finest orchards. Foster a healthy lifestyle with the benefits of oranges. 100 percent orange juice with no added sugar for a healthy you.",
	"price": "￥999",
	"url": "http://10.242.118.244:8000/shop-detail.html",
	"activity":"活动活动活动活动活动活动活动活动活动活动活动活动活动活动活动活动活动活动",
	"activityHref": "https://www.baidu.com",
	"showCustomMsg":1
}

//Attachment 一定要继承 UnicornAttachmentBase
public class DemoCustomProductAttachment extends UnicornAttachmentBase {
	//想要展示的信息
    private String customProductString;

	// attach 字段可以通过 CustomProductParser 的 parseCustomProduct 的参数获取
	 public DemoCustomProductAttachment(String attach) {
        super(attach);
    }


    public String getCustomProductString() {
        return customProductString;
    }

    public void setCustomProductString(String customProductString) {
        this.customProductString = customProductString;
    }
}

public class DemoCustomProductHolder extends UnicornMessageViewHolder {
    private TextView tvDemoViewHolder;
	//返回消息样式的layout id
    @Override
    public int getViewHolderResId() {
        return R.layout.viewholder_product;
    }
	//初始化相关 view
    @Override
    public void inflateFindView() {
        tvDemoViewHolder = findViewById(R.id.tv_demo_view_holder);
    }
	//进行数据绑定
    @Override
    public void bindContentView(IMMessage message, Context context) {
        DemoCustomProductAttachment demoCustomProductAttachment = (DemoCustomProductAttachment) message.getAttachment();
        tvDemoViewHolder.setText(demoCustomProductAttachment.getCustomProductString());
    }
}

YSFOptions options = new YSFOptions();
options.customProductParser = DemoMsgParser.getInstance();

public class DemoMsgParser implements CustomProductParser {
	//单例对象
    private static DemoMsgParser instance;

    public static DemoMsgParser getInstance() {
        if (instance == null) {
            instance = new DemoMsgParser();
        }
        return instance;
    }

    private DemoMsgParser() {
    }
    //重写了自定义商品消息的解析方法，当有自定义商品消息的时候会回调该方法，用户需要把
    //解析完成 Attachment return 给 SDK
    @Override
    public UnicornAttachmentBase parseCustomProduct(String attach) {
        DemoCustomProductAttachment attachment = new DemoCustomProductAttachment(attach);
        try {
            JSONObject jsonObject = new JSONObject(attach);
            attachment.setCustomProductString(jsonObject.getString("productCustomField"));
        } catch (JSONException e) {
            e.printStackTrace();
        }
        return attachment;
    }
}

MsgCustomizationRegistry.registerMessageViewHolder(DemoCustomProductAttachment.class, DemoCustomProductHolder.class);

public static void sendCardMessage(String cardJson)
public static void sendCardMessage(String cardJson, int sendProToRobot)
public static void sendCardMessage(String cardJson, int sendByUser, int sendProToRobot,
                                   String actionText, String actionTextColor,
                                   String intent, String params)
public static void sendCardMessage(String shopId, String cardJson, int sendByUser,
                                   int sendProToRobot, String actionText, String actionTextColor,
                                   String intent, String params)

// 标准版
MessageService.sendCardMessage(cardJson);

// 平台版
MessageService.sendCardMessage(
        shopId, cardJson, 0, 0,
        "发送", "#337EFF", null, null);

String cardJson = "{\"msgtype\":\"cardMessage\",\"cards\":["
        + "{\"type\":\"title\",\"content\":\"订单信息\"},"
        + "{\"type\":\"subtitle\",\"content\":\"订单编号\","
        + "\"subContent\":\"202608180001\"}]}";
CardDetail cardDetail = new CardDetail(cardJson, 0, 0, "发送", "#337EFF");

ConsultSource source = new ConsultSource("order_detail", "订单详情", null);
source.cardDetail = cardDetail;
Unicorn.openServiceActivity(context, "订单咨询", source);

public CardDetail()
public CardDetail(String cardJson, int sendByUser, String actionText, String actionTextColor)
public CardDetail(String cardJson, int sendByUser, int sendProToRobot, String actionText, String actionTextColor)
public CardDetail(String shopId)
public CardDetail(String shopId, String cardJson, int sendByUser, int sendProToRobot, String actionText, String actionTextColor)
public CardDetail(String shopId, String cardJson, int sendByUser, String actionText, String actionTextColor)

YSFOptions options = new YSFOptions();
options.productOrderCardMessageWhiteBubbleEnabled = true;
Unicorn.config(context, appKey, options, imageLoader);

// SDK 已初始化时更新
options.productOrderCardMessageWhiteBubbleEnabled = false;
Unicorn.updateOptions(options);

{
  "msgtype": "cardMessage",
  "cards": [
    {
      "type": "title",
      "content": "订单信息"
    }
  ]
}

String cardJson = "{\"msgtype\":\"cardMessage\",\"cards\":["
        + "{\"type\":\"title\",\"content\":\"订单信息\"},"
        + "{\"type\":\"subtitle\",\"content\":\"订单编号\","
        + "\"subContent\":\"202608180001\"}]}";
CardDetail cardDetail = new CardDetail(cardJson, 0, 0, "发送", "#337EFF");
// 其他字段可以通过 setter 设置
cardDetail.setIntent("intent");
cardDetail.setParams("params");
source.cardDetail = cardDetail;

//第一步
//当使用视频相关功能时，创建 UnicornVideoPickHelper
unicornVideoPickHelper = new UnicornVideoPickHelper(this, new UnicornVideoPickHelper.UincornVideoSelectListener() {

            @Override
            public void onVideoPicked(File file, String md5) {
            //当视频处理成功的时候，我们需要去发送视频类型的消息
                MediaPlayer mediaPlayer = getVideoMediaPlayer(file);
                long duration = mediaPlayer == null ? 0 : mediaPlayer.getDuration();
                int height = mediaPlayer == null ? 0 : mediaPlayer.getVideoHeight();
                int width = mediaPlayer == null ? 0 : mediaPlayer.getVideoWidth();
                IMMessage message = UnicornMessageBuilder.buildVideoMessage(file, duration, width, height, md5);
                MessageService.sendMessage(message);
            }
        });
//当使用图片相关功能时，创建 UnicornPickImageHelper
        unicornPickImageHelper = new UnicornPickImageHelper(this, new UnicornPickImageHelper.SendImageCallback() {
            @Override
            public void sendImage(File file, String origName, boolean isOrig) {
            //当图片处理成功的时候，发送图片类型的消息
                IMMessage message = UnicornMessageBuilder.buildImageMessage(UnicornMessageBuilder.getSessionId(), file, file.getName());
                MessageService.sendMessage(message);
            }
        });


//第二步，在 APP 想要启动 SDK 界面的时候，调用相关方法启动
private void addPhoneMenu() {
        addImageMenu(R.drawable.ic_action_album).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //启动选择相册图片
                unicornPickImageHelper.goUnicornAlbum(ALBUM_IMAGE_REQUEST_CODE);
            }
        });
        addImageMenu(R.drawable.ic_action_camera).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //启动拍摄照片
                unicornPickImageHelper.goUnicornCapturePhoto(CAPTURE_IMAGE_REQUEST_CODE);
            }
        });
        addImageMenu(R.drawable.ic_action_take_video).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //启动拍摄视频界面
                unicornVideoPickHelper.goCaptureVideo(CAPTURE_VIDEO_REQUEST_CODE);
            }
        });
        addImageMenu(R.drawable.ic_action_select_video).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //启动选择视频界面
                unicornVideoPickHelper.goVideoAlbum(LOCAL_VIDEO_REQUEST_CODE);
            }
        });
    }


//第三步，在 onActivityResult 中把数据回传给 SDK
@Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        switch (requestCode) {
            case CAPTURE_VIDEO_REQUEST_CODE:
                //拍摄视频使用
                unicornVideoPickHelper.onCaptureVideoResult(data);
                break;
            case LOCAL_VIDEO_REQUEST_CODE:
                //从相册中选择视频使用
                unicornVideoPickHelper.onSelectLocalVideoResult(data);
                break;
            case ALBUM_IMAGE_REQUEST_CODE:
                //从相册中选择照片使用
                unicornPickImageHelper.onAlbumResult(data);
                break;
            case CAPTURE_IMAGE_REQUEST_CODE:
                //拍照中使用
                unicornPickImageHelper.onCapturePhotoResult(data, CAPTURE_IMAGE_PROCESS_REQUEST_CODE);
                break;
            case CAPTURE_IMAGE_PROCESS_REQUEST_CODE:
                //拍照中使用
                unicornPickImageHelper.onCapturePhotoPorcessResult(data, CAPTURE_IMAGE_REQUEST_CODE);
                break;
        }
}

public static void onSelectLocalVideoResult(
        Intent data,
        UnicornVideoPickHelper.UincornVideoSelectListener listener)

// 在 Fragment 中打开视频选择页
UnicornVideoPickHelper.goVideoAlbumActivity(this, LOCAL_VIDEO_REQUEST_CODE);

@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == LOCAL_VIDEO_REQUEST_CODE && resultCode == Activity.RESULT_OK) {
        UnicornVideoPickHelper.onSelectLocalVideoResult(
                data,
                new UnicornVideoPickHelper.UincornVideoSelectListener() {
                    @Override
                    public void onVideoPicked(File file, String md5) {
                        // 使用 UnicornMessageBuilder 构造视频消息并发送
                    }
                });
    }
}

public void openWorkSheetDialog(long templateId, String exchange, int watchAnnexRequestCode, int selectAnnexRequestCode, RequestCallback<String> requestCallback)
public void onResultWorkSheet(int requestCode, Intent data)

UnicornWorkSheetHelper helper = new UnicornWorkSheetHelper(fragment);
helper.openWorkSheetDialog(templateId, exchange, WATCH_ANNEX_REQUEST_CODE, SELECT_ANNEX_REQUEST_CODE, new RequestCallback<String>() {
    @Override
    public void onSuccess(String result) {
        // 工单提交成功
    }

    @Override
    public void onFailed(int code) {
        // 工单提交失败
    }

    @Override
    public void onException(Throwable exception) {
        // 异常处理
    }
});

public static void openUserWorkSheetActivity(Context context, List<Long> templateIds, boolean isOpenUrge, String exchange)

List<Long> templateIds = new ArrayList<>();
templateIds.add(templateId);
UnicornWorkSheetHelper.openUserWorkSheetActivity(context, templateIds, true, UnicornMessageBuilder.getSessionId());

InquireWorkSheetAction action = new InquireWorkSheetAction(R.drawable.ic_work_sheet, "工单");
action.setTemplateIds(templateIds);
action.setOpenUrge(true);