Skip to content

Commit 4b5ceeb

Browse files
committed
add callout to use spectrum
1 parent 7cde0b9 commit 4b5ceeb

5 files changed

Lines changed: 29 additions & 6 deletions

File tree

docs-src/advanced-kits/imessage/getting-started.mdx.vel

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@ title: "Getting Started"
33
description: "Install the Advanced iMessage SDK, connect to a server, and send your first message"
44
---
55

6+
<Note>
7+
Most apps should use [Spectrum](/spectrum-ts/getting-started) - it gives you
8+
a unified, higher-level API across iMessage, WhatsApp Business, and other
9+
platforms. Reach for `@photon-ai/advanced-imessage` directly only when you
10+
need low-level iMessage control that Spectrum doesn't expose.
11+
</Note>
12+
613
`@photon-ai/advanced-imessage` is an ESM-only TypeScript SDK for the Advanced iMessage v2 gRPC server. It exposes resource-oriented namespaces for messages, chats, groups, attachments, addresses, polls, shared locations, and durable events.
714

815
The SDK is intentionally thin: each method maps closely to a server RPC, returns typed public objects, and keeps stream recovery explicit.

docs-src/advanced-kits/whatsapp/getting-started.mdx.vel

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ description: "Connect the WhatsApp Business SDK and send your first message"
55

66
import { TypeTooltip } from "/snippets/type-tooltip.mdx";
77

8+
<Note>
9+
Most apps should use [Spectrum](/spectrum-ts/getting-started) - it gives you
10+
a unified, higher-level API across WhatsApp Business, iMessage, and other
11+
platforms. Reach for `@photon-ai/whatsapp-business` directly only when you
12+
need low-level WhatsApp control that Spectrum doesn't expose.
13+
</Note>
14+
815
`@photon-ai/whatsapp-business` is a TypeScript SDK for the WhatsApp Business API. It connects to our managed gRPC gateway, which fronts Meta's Cloud API — you get typed message sending, a resumable event stream, and media handling without wiring webhooks yourself.
916

1017
## Installation

docs-src/opensource/imessage-kit.mdx.vel

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ import { TypeTooltip } from "/snippets/type-tooltip.mdx";
88
`@photon-ai/imessage-kit` is an MIT-licensed, macOS-only SDK that talks directly to the local Messages database and AppleScript bridge. Use it when you want to read, send, and automate iMessage on a Mac you control — automation tools, AI agents, chat-first apps.
99

1010
<Note>
11-
For remote iMessage delivery, threaded replies, tapbacks, edits / unsends, and
12-
live typing indicators, use
13-
[`@photon-ai/advanced-imessage`](/advanced-kits/imessage/getting-started)
14-
instead. That SDK talks to a hosted bridge and doesn't require macOS.
11+
This SDK is for talking to iMessage **locally on a Mac you control**. If you
12+
want remote/hosted iMessage delivery, threaded replies, tapbacks, edits /
13+
unsends, and live typing indicators, use
14+
[Spectrum](/spectrum-ts/getting-started) for a unified API across platforms,
15+
or [`@photon-ai/advanced-imessage`](/advanced-kits/imessage/getting-started)
16+
when you need low-level iMessage control.
1517
</Note>
1618

1719
## Requirements

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
"tab": "Platform SDKs",
6868
"groups": [
6969
{
70-
"group": "Advanced kits",
70+
"group": "Advanced Kits",
7171
"pages": [
7272
{
7373
"group": "iMessage",

legacy/imessage.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@ title: "iMessage (Legacy)"
33
description: "Documentation for the legacy @photon-ai/advanced-imessage-kit SDK"
44
---
55

6-
`@photon-ai/advanced-imessage-kit` is the legacy HTTP + Socket.IO-based iMessage SDK. For new projects, use [`@photon-ai/advanced-imessage`](/advanced-kits/imessage/getting-started) instead.
6+
`@photon-ai/advanced-imessage-kit` is the legacy HTTP + Socket.IO-based iMessage SDK and is no longer recommended for new projects.
7+
8+
<Note>
9+
For new projects, use [Spectrum](/spectrum-ts/getting-started) for a unified,
10+
higher-level API across platforms, or
11+
[`@photon-ai/advanced-imessage`](/advanced-kits/imessage/getting-started) when
12+
you need low-level iMessage control.
13+
</Note>
714

815
## Installation
916

0 commit comments

Comments
 (0)