Skip to content

Commit f2dd24e

Browse files
authored
API doc updates (#293)
1 parent d6a1671 commit f2dd24e

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

firebase_admin/_messaging_utils.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,8 @@ def __init__(self, data=None, notification=None, android=None, webpush=None, apn
5757
class MulticastMessage(object):
5858
"""A message that can be sent to multiple tokens via Firebase Cloud Messaging.
5959
60-
Contains payload information as well as recipient information. In particular, the message must
61-
contain exactly one of token, topic or condition fields.
62-
6360
Args:
64-
tokens: A list of registration token of the device to which the message should be sent.
61+
tokens: A list of registration tokens of targeted devices.
6562
data: A dictionary of data fields (optional). All keys and values in the dictionary must be
6663
strings.
6764
notification: An instance of ``messaging.Notification`` (optional).

firebase_admin/db.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ def listen(self, callback):
351351
352352
The specified callback function will get invoked with ``db.Event`` objects for each
353353
realtime update received from the database. It will also get called whenever the SDK
354-
reconnects to the server due to network issues and credential expiration. In general,
354+
reconnects to the server due to network issues or credential expiration. In general,
355355
the OAuth2 credentials used to authorize connections to the server expire every hour.
356356
Therefore clients should expect the ``callback`` to fire at least once every hour, even if
357357
there are no updates in the database.

firebase_admin/messaging.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ def send(message, dry_run=False, app=None):
9494
string: A message ID string that uniquely identifies the sent the message.
9595
9696
Raises:
97-
ApiCallError: If an error occurs while sending the message to FCM service.
97+
ApiCallError: If an error occurs while sending the message to the FCM service.
9898
ValueError: If the input arguments are invalid.
9999
"""
100100
return _get_messaging_service(app).send(message, dry_run)
@@ -114,7 +114,7 @@ def send_all(messages, dry_run=False, app=None):
114114
BatchResponse: A ``messaging.BatchResponse`` instance.
115115
116116
Raises:
117-
ApiCallError: If an error occurs while sending the message to FCM service.
117+
ApiCallError: If an error occurs while sending the message to the FCM service.
118118
ValueError: If the input arguments are invalid.
119119
"""
120120
return _get_messaging_service(app).send_all(messages, dry_run)
@@ -134,7 +134,7 @@ def send_multicast(multicast_message, dry_run=False, app=None):
134134
BatchResponse: A ``messaging.BatchResponse`` instance.
135135
136136
Raises:
137-
ApiCallError: If an error occurs while sending the message to FCM service.
137+
ApiCallError: If an error occurs while sending the message to the FCM service.
138138
ValueError: If the input arguments are invalid.
139139
"""
140140
if not isinstance(multicast_message, MulticastMessage):
@@ -285,7 +285,7 @@ def __init__(self, resp, exception):
285285

286286
@property
287287
def message_id(self):
288-
"""A message ID string that uniquely identifies the sent the message."""
288+
"""A message ID string that uniquely identifies the message."""
289289
return self._message_id
290290

291291
@property
@@ -295,7 +295,7 @@ def success(self):
295295

296296
@property
297297
def exception(self):
298-
"""A ApiCallError if an error occurs while sending the message to FCM service."""
298+
"""An ApiCallError if an error occurs while sending the message to the FCM service."""
299299
return self._exception
300300

301301

0 commit comments

Comments
 (0)