Share.createLink

Functional API getTossShareLinkYou can use the same functionality with it as well. The functional API is getTossShareLink(path, ogImageUrl) takes positional arguments in the form of.

Feature description

Creates a share link that can open the specified path in the Toss app. When you share this link, the Toss app launches and enters the specified path. People without the Toss app are taken to the App Store on iOS and to the Play Store on Android.

The path intoss://must be in a deep link format that starts with. For example intoss://my-app or intoss://my-app/about?name=testwrite it like this.

Optionally, you can pass an OG image URL (ogImageUrl) ogImageUrlis only available on Toss app Android 5.240.0, iOS 5.239.0 and above. On earlier versions, the default share link has deep_link_value the query appended to create the link.

Type

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

Params

{
  /** The path you want to open as a deep link. It must start with `intoss://`. */
  path: string;
  /** The OG image URL to use for the share link preview. */
  ogImageUrl?: string;
}

Response

Returns a share link string that can be opened in the Toss app.

Example code

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);
}