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.AndroidNotification.properties.proxy.type (Total Keys: 1)
  • Loading branch information
yoshi-automation committed May 24, 2023
1 parent cfb96ec commit 8150345
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/dyn/fcm_v1.projects.messages.html
Expand Up @@ -135,6 +135,7 @@ <h3>Method Details</h3>
&quot;localOnly&quot;: True or False, # Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging)
&quot;notificationCount&quot;: 42, # Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you&#x27;re using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If zero or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives.
&quot;notificationPriority&quot;: &quot;A String&quot;, # Set the relative priority for this notification. Priority is an indication of how much of the user&#x27;s attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered.
&quot;proxy&quot;: &quot;A String&quot;, # Setting to control when a notification may be proxied.
&quot;sound&quot;: &quot;A String&quot;, # The sound to play when the device receives the notification. Supports &quot;default&quot; or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.
&quot;sticky&quot;: True or False, # When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it.
&quot;tag&quot;: &quot;A String&quot;, # Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.
Expand Down Expand Up @@ -246,6 +247,7 @@ <h3>Method Details</h3>
&quot;localOnly&quot;: True or False, # Set whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged. See [Wear OS guides](https://developer.android.com/training/wearables/notifications/bridger#existing-method-of-preventing-bridging)
&quot;notificationCount&quot;: 42, # Sets the number of items this notification represents. May be displayed as a badge count for launchers that support badging.See [Notification Badge](https://developer.android.com/training/notify-user/badges). For example, this might be useful if you&#x27;re using just one notification to represent multiple new messages but you want the count here to represent the number of total new messages. If zero or unspecified, systems that support badging use the default, which is to increment a number displayed on the long-press menu each time a new notification arrives.
&quot;notificationPriority&quot;: &quot;A String&quot;, # Set the relative priority for this notification. Priority is an indication of how much of the user&#x27;s attention should be consumed by this notification. Low-priority notifications may be hidden from the user in certain situations, while the user might be interrupted for a higher-priority notification. The effect of setting the same priorities may differ slightly on different platforms. Note this priority differs from `AndroidMessagePriority`. This priority is processed by the client after the message has been delivered, whereas [AndroidMessagePriority](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#androidmessagepriority) is an FCM concept that controls when the message is delivered.
&quot;proxy&quot;: &quot;A String&quot;, # Setting to control when a notification may be proxied.
&quot;sound&quot;: &quot;A String&quot;, # The sound to play when the device receives the notification. Supports &quot;default&quot; or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.
&quot;sticky&quot;: True or False, # When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it.
&quot;tag&quot;: &quot;A String&quot;, # Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.
Expand Down
18 changes: 17 additions & 1 deletion googleapiclient/discovery_cache/documents/fcm.v1.json
Expand Up @@ -146,7 +146,7 @@
}
}
},
"revision": "20230413",
"revision": "20230515",
"rootUrl": "https://fcm.googleapis.com/",
"schemas": {
"AndroidConfig": {
Expand Down Expand Up @@ -304,6 +304,22 @@
],
"type": "string"
},
"proxy": {
"description": "Setting to control when a notification may be proxied.",
"enum": [
"PROXY_UNSPECIFIED",
"ALLOW",
"DENY",
"IF_PRIORITY_LOWERED"
],
"enumDescriptions": [
"If unspecified, default to `Proxy.IF_PRIORITY_LOWERED`.",
"Try to proxy this notification.",
"Do not proxy this notification.",
"Only try to proxy this notification if its `AndroidMessagePriority` was lowered from `HIGH` to `NORMAL` on the device."
],
"type": "string"
},
"sound": {
"description": "The sound to play when the device receives the notification. Supports \"default\" or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.",
"type": "string"
Expand Down

0 comments on commit 8150345

Please sign in to comment.