Skip to content

Slack

Slack 是一款面向团队沟通、频道、消息、文件和应用的协作平台。Protocol Launcher 允许您生成深度链接,用于打开 Slack 工作区、频道、用户、应用和文件。

使用方式

有两种使用此库的方式:

  • 按需导入(On-Demand):从子路径导入支持 tree-shaking,保持较小的打包体积。
  • 完整导入(Full Import):从根包导入更方便,但会包含所有应用模块。

生产构建建议选择按需导入;快速脚本或演示可以使用完整导入。

选择安装方式

按需加载
推荐使用。生产环境优化。
全量导入
使用便捷。适合快速脚本。

注意事项

Slack 的 slack:// URI 模板使用工作区、频道、用户、应用和文件的 Slack ID。它们不支持工作区子域名、频道名称、用户名或文件名。如果需要使用官方支持的频道名称跳转形式,请使用 Slack 的 app_redirect URL。

打开 Slack

打开 Slack 原生客户端。传入 team 时会切换到指定工作区。

On-Demand
ts
import { open } from 'protocol-launcher/slack'

const url = open({
  team: 'T12345',
})

应用重定向

生成 Slack app_redirect URL,用于打开与应用或机器人的私信。

On-Demand
ts
import { appRedirect } from 'protocol-launcher/slack'

const url = appRedirect({
  app: 'A123ABC456',
  team: 'T12345',
})

频道重定向

生成 Slack app_redirect URL,用于通过频道 ID 或频道名称打开频道。

On-Demand
ts
import { channelRedirect } from 'protocol-launcher/slack'

const url = channelRedirect({
  channel: 'release-notes',
  team: 'T12345',
})

打开 App Home

通过工作区 ID 和应用 ID 打开 Slack App Home。可选的 tab 值为 homeaboutmessages

On-Demand
ts
import { openApp } from 'protocol-launcher/slack'

const url = openApp({
  team: 'T12345',
  id: 'A123ABC456',
  tab: 'home',
})

打开频道

通过工作区 ID 和频道 ID 打开 Slack 频道。

On-Demand
ts
import { openChannel } from 'protocol-launcher/slack'

const url = openChannel({
  team: 'T12345',
  id: 'C123ABC456',
})

打开私信

通过工作区 ID 和用户 ID 打开与 Slack 用户的私信。

On-Demand
ts
import { openUser } from 'protocol-launcher/slack'

const url = openUser({
  team: 'T12345',
  id: 'U123ABC456',
})

打开文件

通过工作区 ID 和文件 ID 打开 Slack 文件。

On-Demand
ts
import { openFile } from 'protocol-launcher/slack'

const url = openFile({
  team: 'T12345',
  id: 'F123ABC456',
})

分享文件

通过工作区 ID 和文件 ID 打开 Slack 文件分享对话框。

On-Demand
ts
import { shareFile } from 'protocol-launcher/slack'

const url = shareFile({
  team: 'T12345',
  id: 'F123ABC456',
})

官方文档