docs(push): add iOS Live Activities page#3464
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Probably a question for the devex team but is there a way to force it to show something for a snippet even if it's not in the selected language? Else you have to keep flipping the language selector between JS and Swift to view the full page. |
| ``` | ||
| </Code> | ||
|
|
||
| Finally, make the device targetable for push-to-start. Either subscribe it to an Ably channel: |
There was a problem hiding this comment.
It took me a while to understand why Ably channels are introduced here. I think it would be useful to say something like "the Ably channel is only used to select which devices to push-to-start; it has nothing to do with the broadcast channel that carries updates"
| ``` | ||
| </Code> | ||
|
|
||
| The underlying REST endpoint is `POST /push/apnsBroadcastChannels/{id}/broadcast`. |
There was a problem hiding this comment.
Maybe add one clause on why update() posts to /broadcast — an update is a single broadcast to the channel
| | `attributes-type` | start | The exact name of the Swift `ActivityAttributes` struct. | | ||
| | `attributes` | start | The activity's fixed attributes; `Date` values as Unix epoch seconds. | | ||
| | `input-push-channel` | start | The `apnsChannelId` the started activity subscribes to for broadcast updates. | | ||
| | `alert` | start | The user-visible notification shown when the activity starts. | |
There was a problem hiding this comment.
Is this also used in update (not just start)?
3561365 to
009ead0
Compare
009ead0 to
a59c5b0
Compare
- Attribute update fan-out to APNs and clarify the one-time channel create plus three lifecycle calls in the intro - Fix the APNs config link (needs ?lang=swift) and use ".p8 authentication key" terminology - Add the push-admin capability prerequisite - Correct iOS requirements: broadcast channels need iOS 18, not 17.2 - Remove the activate(pushToStart:) section; that API is not yet in ably-cocoa - Clarify that the Ably channel only selects push-to-start targets and is unrelated to the APNs broadcast channel - Note that update() posts to /broadcast because an update is a single broadcast, and that alert is also valid in update events - Style guide fixes: remove em-dashes and bold list prefixes Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
a59c5b0 to
216f0e8
Compare
4 participants
Description
Document starting, updating, and ending iOS Live Activities via Ably-managed APNs broadcast channels: device registration with push-to-start tokens, broadcast channel creation, the start/update/end server calls, and an aps payload and headers reference. Marked Experimental.
Checklist