Skip to content

Commit ebbe8da

Browse files
docs: update advanced-imessage-ts documentation for v0.11.0 (#78)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 5158bf1 commit ebbe8da

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

docs-src/advanced-kits/imessage/messages.mdx.vel

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ await im.messages.sendAttachment(chat.guid, audio.attachment.guid, {
188188

189189
`sendCustomizedMiniApp(...)` sends a card that, when tapped, opens your iMessage extension and hands it `url`. Use it to launch your own app with a structured payload; for plain link previews, just put the URL in `sendText(...)`.
190190

191-
You need a published iMessage extension on the App Store before you can call this. `appName`, `appStoreId`, `teamId`, and `extensionBundleId` identify that extension so Messages.app can route the tap to it on the recipient's device.
191+
You need a published iMessage extension on the App Store before you can call this. `appName`, `teamId`, and `extensionBundleId` identify that extension so Messages.app can route the tap to it on the recipient's device. `appStoreId` is optional — when set, recipients without the extension installed see an App Store install prompt.
192192

193193
For most cards we recommend an image preview with an overlaid title:
194194

@@ -211,7 +211,7 @@ console.log(sent.guid);
211211
| Field | Meaning |
212212
|---|---|
213213
| `appName` | Display name of your app. Recipients without your extension installed see this on an App Store install prompt. |
214-
| `appStoreId` | Numeric App Store id, e.g. `1234567890` from `apps.apple.com/app/id1234567890`. Positive integer. |
214+
| `appStoreId` | Optional numeric App Store id, e.g. `1234567890` from `apps.apple.com/app/id1234567890`. When set, must be a positive integer. |
215215
| `teamId` | 10-character uppercase alphanumeric Apple Team ID. Find it in App Store Connect → Membership. |
216216
| `extensionBundleId` | Bundle identifier of the iMessage extension target inside your app. |
217217
| `url` | Absolute URL delivered to your extension when the recipient taps the card. |

pnpm-lock.yaml

Lines changed: 12 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)