Gauss

Appearance

@gauss/tine-chat-sdk ​

tine-chat-sdk 是一个专为 Web 和 H5 应用设计的软件开发包，用于实现与 TineChat 通信平台的无缝集成和交互。开发者使用 SDK 可轻松集成即时通讯等功能。

SDK 功能简介：

  1. 唤起聊天界面。
  2. 唤起聊天界面，并发送文字消息。
  3. 唤起聊天界面，并发送企业 OA 工作流卡片。

指南 ​

安装 ​

shell
$ yarn add @gauss/tine-chat-sdk -S
$ yarn add @gauss/tine-chat-sdk -S

使用 ​

js
import { tine } from '@gauss/tine-chat-sdk'

// 打开域账户
tine.chat('jinhua.gong')
import { tine } from '@gauss/tine-chat-sdk'

// 打开域账户
tine.chat('jinhua.gong')

tine.chat ​

ts
tine.chat(username) | tine.chat({ roomId: string })
tine.chat(username) | tine.chat({ roomId: string })

唤起单聊或群聊，默认通过域账户打开或创建单聊，也可通过 roomId 参数指定单聊或群聊。

参数 ​

  • username (string): 域账户
  • roomId (string): 单聊或群聊 id

例子 ​

js
// 通过域账户唤起或创建单聊
tine.chat('jinhua.gong')
// 等同于
tine.chat({ username: 'jinhua.gong' })

// roomId 指定单聊或群聊
tine.chat({ roomId: 'h8xFzTadoRgkzrHyx' })
// 通过域账户唤起或创建单聊
tine.chat('jinhua.gong')
// 等同于
tine.chat({ username: 'jinhua.gong' })

// roomId 指定单聊或群聊
tine.chat({ roomId: 'h8xFzTadoRgkzrHyx' })

tine.send ​

唤起单聊或群聊的同时并发送文字消息。

ts
tine.send({ username, roomId, msg, manual })
tine.send({ username, roomId, msg, manual })

参数 ​

  • username (string): 域账户
  • roomId (string): 单聊或群聊 id
  • msg (string): 消息内容
  • manual (boolean): 是否手动发送消息，默认为 false

例子 ​

js
// 通过域账户直接给用户发送消息
tine.send({ username: 'jinhua.gong', msg: '你好呀' })

// 手动给用户发送消息，msg 默认填入到聊天框
tine.send({ username: 'jinhua.gong', msg: '你好呀', manual: true })

tine.send({ roomId: 'mqNEZN4ebBo2L7MnH', msg: '你好呀', manual: true })
// 通过域账户直接给用户发送消息
tine.send({ username: 'jinhua.gong', msg: '你好呀' })

// 手动给用户发送消息，msg 默认填入到聊天框
tine.send({ username: 'jinhua.gong', msg: '你好呀', manual: true })

tine.send({ roomId: 'mqNEZN4ebBo2L7MnH', msg: '你好呀', manual: true })

tine.sendOAWorkflowCard ​

向用户或者群聊发送 OA 工作流卡片

ts
tine.sendOAWorkflowCard({ username, roomId, manual, workflowId, cardType })
tine.sendOAWorkflowCard({ username, roomId, manual, workflowId, cardType })

参数 ​

  • username (string): 域账户
  • roomId (string): 单聊或群聊 id
  • manual (boolean): 是否手动发送消息，默认为 true
  • workflowId (string): OA 工作流 id
  • cardType (string | number): OA 卡片类型，1-流程单，2-催办信息

例子 ​

js
// 发送OA流程卡片，手动发送
tine.sendOAWorkflowCard({ username: 'jinhua.gong', workflowId: '1081287', cardType: '1' })
// 发送OA催办信息卡片，手动发送
tine.sendOAWorkflowCard({ username: 'jinhua.gong', workflowId: '1081287', cardType: '2' })

// 发送OA流程卡片，直接发送
tine.sendOAWorkflowCard({
    username: 'jinhua.gong',
    workflowId: '1081287',
    manual: false,
    cardType: '1',
})
tine.sendOAWorkflowCard({
    roomId: 'h8xFzTadoRgkzrHyx',
    workflowId: '1081287',
    manual: false,
    cardType: '1',
})
// 发送OA流程卡片，手动发送
tine.sendOAWorkflowCard({ username: 'jinhua.gong', workflowId: '1081287', cardType: '1' })
// 发送OA催办信息卡片，手动发送
tine.sendOAWorkflowCard({ username: 'jinhua.gong', workflowId: '1081287', cardType: '2' })

// 发送OA流程卡片，直接发送
tine.sendOAWorkflowCard({
    username: 'jinhua.gong',
    workflowId: '1081287',
    manual: false,
    cardType: '1',
})
tine.sendOAWorkflowCard({
    roomId: 'h8xFzTadoRgkzrHyx',
    workflowId: '1081287',
    manual: false,
    cardType: '1',
})

Contributors ​

jinhua.gong

Copyright © 2023-present Gauss