Share.createLink

函数式 API getTossShareLink也可以使用相同功能。函数式 API 是 getTossShareLink(path, ogImageUrl) 接收这种形式的位置参数。

功能说明

创建一个可在 Toss 应用中打开指定路径的分享链接。分享此链接时，会启动 Toss 应用并进入指定路径。没有 Toss 应用的人在 iOS 上会跳转到 App Store，在 Android 上会跳转到 Play 商店。

路径是 intoss://必须是以 `intoss://` 开头的深度链接格式。例如 intoss://my-app 或 intoss://my-app/about?name=test这样写。

可选地，OG 图片 URL(ogImageUrl)也可以传入。 ogImageUrl仅在 Toss 应用 Android 5.240.0, iOS 5.239.0 及以上版本适用。低于该版本时，会在默认分享链接上 包含 deep_link_value 附加查询参数来生成链接。

类型

Share.createLink(params: { path: string; ogImageUrl?: string }): Promise<string>;

Params

{
  /** 这是希望用深度链接打开的路径。必须以 `intoss://` 开头。 */
  path: string;
  /** 用于分享链接预览的 OG 图片 URL。 */
  ogImageUrl?: string;
}

Response

返回可在 Toss 应用中打开的分享链接字符串。

示例代码

JavaScript

import { Share } from "@apps-in-toss/web-framework";

try {
  const tossLink = await Share.createLink({ path: "intoss://my-app" });
  await Share.sendMessage({ message: tossLink });
} catch (error) {
  console.error(error);
}