tencent cloud

文档反馈

最后更新时间:2023-08-23 16:50:40
    以下为您介绍,如何为腾讯云 IM Flutter TUIKit 引入表情能力。

    介绍

    我们的 TIMUIKitChat 组件中,支持发送及接收三种类型的表情:
    表情类型
    发送形式
    是否文字混排
    发送内容
    解析方式
    引入方式
    TUIKit 默认自带
    Unicode Emoji 表情
    文本消息
    Unicode编码
    设备自动将 Unicode 编码解析成小表情。不同的设备,对Unicode解析后的图形,略有不同
    默认启用,默认包含一套 Unicode 列表,可自定义。
    默认包含一套 Unicode 列表,可自定义。
    小图片表情
    文本消息
    表情图片名称
    根据名称,自动匹配本地 Asset 图片资源
    默认的可直接用,自定义图片资源预存于Asset,并定义 List
    两套默认小表情图库(如下发截图),可直接使用
    大图片表情
    表情消息
    baseURL 拼接图片文件名,表情图片 Asset 路径
    通过路径,解析 Asset 资源
    图片资源预存于Asset,并定义 List
    -
    具体效果如下:
    案例名称
    小图片表情
    (我们自己设计)
    小图片表情
    (QQ 同款)
    Emoji Unicode
    腾讯云大图片表情
    表情类型
    小图片表情
    Unicode Emoji 表情
    大图片表情
    案例说明
    默认自带启用,位于第一栏
    默认自带启用,位于第二栏
    默认自带启用,位于第三栏。默认包含一套 Unicode 列表,可自定义
    没有默认提供,可以按照文档所述用法,快速传入自定义表情包
    截图展示
    图1
    图1
    
    图2
    图2
    
    图3
    图3
    
    图4
    图4
    

    配置指引

    使用默认配置

    进入 UIKit 会话聊天页面后,上方表格左侧三组表情包,会默认启用,无需额外配置。

    自定义配置

    表情能力自定义配置,全部使用 TIMUIKitChatConfig 中的 stickerPanelConfig 参数进行。该参数需要传入 StickerPanelConfig 类进行指定配置。
    TIMUIKitChat(
    config: TIMUIKitChatConfig(
    stickerPanelConfig: StickerPanelConfig(
    useQQStickerPackage: true, // 是否启用QQ图片小表情包,默认启用
    useTencentCloudChatStickerPackage: true,// 是否启用我们自己设计的图片小表情包,默认启用
    unicodeEmojiList: [], // Unicode Emoji表情包列表,默认提供一组,传入空数组则不启用此表情包
    customStickerPackages: [] // 拓展更多自定义表情包
    ),
    )

    默认图片小表情包

    默认图片小表情包,包含两套:我们自己设计的和 QQ 同款。这两套表情包,无需额外配置,默认启用。
    如无需使用,可通过将 StickerPanelConfiguseQQStickerPackage(QQ同款) 或 useTencentCloudChatStickerPackage(我们自己设计) 配置成 false 即可。
    说明:
    此套表情包效果,如上方截图案例,图1、图2所示。

    Unicode Emoji 表情包

    我们默认提供一组 Unicode Emoji 表情 List,无需额外配置,默认启用。
    如无需使用,可通过在 StickerPanelConfigunicodeEmojiList 中传入空数组即可。
    如需要自定义 Unicode Emoji 表情包,请将您的 Unicode Emoji 列表,以 List<int> 方式传入即可。
    说明:
    此套表情包效果,如上方截图案例,图3所示。

    传入使用自定义表情包

    请将您的表情资源文件,导入项目的 assets/custom_face_resource/ 目录内。无论是图片大表情,抑或是图片小表情,都需按此步骤引入。
    该目录内,请使用不同的文件夹,区分表情面板中的不同 Tab。每个 Tab 内表情,仅支持一种类型,图片大表情或图片小表情。
    文件夹的名称,请使用该 Tab 的 name 命名。该命名不会对客户展现,请根据开发需要,自定义即可。
    请保证,所有表情资源文件,不要重名。
    
    
    
    引入项目后,请将您的表情包列表,以 List<CustomStickerPackage> 方式,传入 StickerPanelConfig customStickerPackages 即可。

    注意事项

    配合 Markdown 使用

    如果同时使用图片小表情包(包含我们默认提供的及您自定义的)和文本消息 Markdown 解析能力,需要您手动将我们的表情包资源,导入您项目的 assets/custom_face_resource/ 目录内。
    该目录下,请分别放置这两个文件夹,4349tcc1
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持