Skip to content

Commit 18cf4ca

Browse files
committed
update notif docs
1 parent f5f7add commit 18cf4ca

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

EmberIotNotifications.h

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,13 +216,16 @@ class FCMEmberNotifications
216216
}
217217

218218
/**
219-
* Send a notification using the FCM service. This function is not synchronous, it will add the notification to a send queue.
219+
* Send a notification using the FCM service. This function is not synchronous, it will add the notification to a queue and send it after.
220+
* If the queue is full the notification will not be sent and will return EMBER_NOTIF_QUEUE_FULL. The queue size is defined by the
221+
* macro EMBER_NOTIFICATION_QUEUE_SIZE.
220222
*
221223
* @param title Notification title. Max size of EMBER_NOTIFICATION_MAX_TITLE_SIZE.
222224
* @param text Notification text. Max size of EMBER_NOTIFICATION_MAX_TEXT_SIZE.
223-
* @param soundId
224-
* @param soundDurationSeconds
225-
* @param loopSound
225+
* @param soundId Id for a custom sound when the notification arrives, useful for setting sound alarms. Check the app docs for valid ids,
226+
* however, they start at 0 and increase one by one. If negative, no sound will play.
227+
* @param soundDurationSeconds Duration in seconds for the sound to play.
228+
* @param loopSound True if the sound effect should be looped for the whole duration, false if it should stop after completing once.
226229
* @return See the EmberSendNotificationStatus enum for cases.
227230
*/
228231
EmberSendNotificationStatus send(

0 commit comments

Comments
 (0)