Skip to content

Commit

Permalink
feat(fcm): update the API
Browse files Browse the repository at this point in the history
#### fcm:v1

The following keys were added:
- schemas.ApnsConfig.properties.liveActivityToken.description
- schemas.ApnsConfig.properties.liveActivityToken.type
  • Loading branch information
yoshi-automation authored and sofisl committed Jan 29, 2025
1 parent 28e11ff commit 2e42883
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 5 additions & 1 deletion discovery/fcm-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
}
}
},
"revision": "20240528",
"revision": "20241112",
"rootUrl": "https://fcm.googleapis.com/",
"schemas": {
"AndroidConfig": {
Expand Down Expand Up @@ -394,6 +394,10 @@
"description": "HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for supported headers such as `apns-expiration` and `apns-priority`. The backend sets a default value for `apns-expiration` of 30 days and a default value for `apns-priority` of 10 if not explicitly set.",
"type": "object"
},
"liveActivityToken": {
"description": "Optional. [Apple Live Activity](https://developer.apple.com/design/human-interface-guidelines/live-activities) token to send updates to. This token can either be a push token or [push-to-start](https://developer.apple.com/documentation/activitykit/activity/pushtostarttoken) token from Apple. To start, update, or end a live activity remotely using FCM, construct an [`aps payload`](https://developer.apple.com/documentation/activitykit/starting-and-updating-live-activities-with-activitykit-push-notifications#Construct-the-payload-that-starts-a-Live-Activity) and put it in the [`apns.payload`](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#ApnsConfig) field.",
"type": "string"
},
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
Expand Down
4 changes: 4 additions & 0 deletions src/apis/fcm/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@ export namespace fcm_v1 {
* HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for supported headers such as `apns-expiration` and `apns-priority`. The backend sets a default value for `apns-expiration` of 30 days and a default value for `apns-priority` of 10 if not explicitly set.
*/
headers?: {[key: string]: string} | null;
/**
* Optional. [Apple Live Activity](https://developer.apple.com/design/human-interface-guidelines/live-activities) token to send updates to. This token can either be a push token or [push-to-start](https://developer.apple.com/documentation/activitykit/activity/pushtostarttoken) token from Apple. To start, update, or end a live activity remotely using FCM, construct an [`aps payload`](https://developer.apple.com/documentation/activitykit/starting-and-updating-live-activities-with-activitykit-push-notifications#Construct-the-payload-that-starts-a-Live-Activity) and put it in the [`apns.payload`](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#ApnsConfig) field.
*/
liveActivityToken?: string | null;
/**
* APNs payload as a JSON object, including both `aps` dictionary and custom payload. See [Payload Key Reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification). If present, it overrides google.firebase.fcm.v1.Notification.title and google.firebase.fcm.v1.Notification.body.
*/
Expand Down

0 comments on commit 2e42883

Please sign in to comment.