Skip to content

API doc updates #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2019
Merged

API doc updates #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56b71ca
API doc updates
hiranya911 May 23, 2019
4f44742
Merge branch 'master' into hkj-doc-update
hiranya911 May 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions firebase_admin/_messaging_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,8 @@ def __init__(self, data=None, notification=None, android=None, webpush=None, apn
class MulticastMessage(object):
"""A message that can be sent to multiple tokens via Firebase Cloud Messaging.

Contains payload information as well as recipient information. In particular, the message must
contain exactly one of token, topic or condition fields.

Args:
tokens: A list of registration token of the device to which the message should be sent.
tokens: A list of registration tokens of targeted devices.
data: A dictionary of data fields (optional). All keys and values in the dictionary must be
strings.
notification: An instance of ``messaging.Notification`` (optional).
Expand Down
2 changes: 1 addition & 1 deletion firebase_admin/db.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ def listen(self, callback):

The specified callback function will get invoked with ``db.Event`` objects for each
realtime update received from the database. It will also get called whenever the SDK
reconnects to the server due to network issues and credential expiration. In general,
reconnects to the server due to network issues or credential expiration. In general,
the OAuth2 credentials used to authorize connections to the server expire every hour.
Therefore clients should expect the ``callback`` to fire at least once every hour, even if
there are no updates in the database.
Expand Down
10 changes: 5 additions & 5 deletions firebase_admin/messaging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def send(message, dry_run=False, app=None):
string: A message ID string that uniquely identifies the sent the message.

Raises:
ApiCallError: If an error occurs while sending the message to FCM service.
ApiCallError: If an error occurs while sending the message to the FCM service.
ValueError: If the input arguments are invalid.
"""
return _get_messaging_service(app).send(message, dry_run)
Expand All @@ -114,7 +114,7 @@ def send_all(messages, dry_run=False, app=None):
BatchResponse: A ``messaging.BatchResponse`` instance.

Raises:
ApiCallError: If an error occurs while sending the message to FCM service.
ApiCallError: If an error occurs while sending the message to the FCM service.
ValueError: If the input arguments are invalid.
"""
return _get_messaging_service(app).send_all(messages, dry_run)
Expand All @@ -134,7 +134,7 @@ def send_multicast(multicast_message, dry_run=False, app=None):
BatchResponse: A ``messaging.BatchResponse`` instance.

Raises:
ApiCallError: If an error occurs while sending the message to FCM service.
ApiCallError: If an error occurs while sending the message to the FCM service.
ValueError: If the input arguments are invalid.
"""
if not isinstance(multicast_message, MulticastMessage):
Expand Down Expand Up @@ -285,7 +285,7 @@ def __init__(self, resp, exception):

@property
def message_id(self):
"""A message ID string that uniquely identifies the sent the message."""
"""A message ID string that uniquely identifies the message."""
return self._message_id

@property
Expand All @@ -295,7 +295,7 @@ def success(self):

@property
def exception(self):
"""A ApiCallError if an error occurs while sending the message to FCM service."""
"""An ApiCallError if an error occurs while sending the message to the FCM service."""
return self._exception


Expand Down