Skip to content

Commit 6de5777

Browse files
authored
Updated instance ID API docs (#193)
* Updated instance ID API docs * Fixing some typos and other minor formatting changes
1 parent 73616a7 commit 6de5777

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

firebase_admin/db.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@
4444

4545

4646
def reference(path='/', app=None, url=None):
47-
"""Returns a database Reference representing the node at the specified path.
47+
"""Returns a database ``Reference`` representing the node at the specified path.
4848
49-
If no path is specified, this function returns a Reference that represents the database root.
50-
By default, the returned References provide access to the Firebase Database specified at
51-
app initialization. To connect to a different Database instance in the same Firebase project,
49+
If no path is specified, this function returns a ``Reference`` that represents the database
50+
root. By default, the returned References provide access to the Firebase Database specified at
51+
app initialization. To connect to a different database instance in the same Firebase project,
5252
specify the ``url`` parameter.
5353
5454
Args:
@@ -350,7 +350,7 @@ def listen(self, callback):
350350
"""Registers the ``callback`` function to receive realtime updates.
351351
352352
The specified callback function will get invoked with ``db.Event`` objects for each
353-
realtime update received from the Database.
353+
realtime update received from the database.
354354
355355
This API is based on the event streaming support available in the Firebase REST API. Each
356356
call to ``listen()`` starts a new HTTP connection and a background thread. This is an

firebase_admin/instance_id.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ def _get_iid_service(app):
3333

3434

3535
def delete_instance_id(instance_id, app=None):
36-
"""Deletes the specified instance ID from Firebase.
36+
"""Deletes the specified instance ID and the associated data from Firebase.
3737
38-
This can be used to delete an instance ID and associated user data from a Firebase project,
39-
pursuant to the General Data Protection Regulation (GDPR).
38+
Note that Google Analytics for Firebase uses its own form of Instance ID to
39+
keep track of analytics data. Therefore deleting a regular Instance ID does
40+
not delete Analytics data. See `Delete an Instance ID`_ for more information.
4041
4142
Args:
4243
instance_id: A non-empty instance ID string.
@@ -45,6 +46,9 @@ def delete_instance_id(instance_id, app=None):
4546
Raises:
4647
InstanceIdError: If an error occurs while invoking the backend instance ID service.
4748
ValueError: If the specified instance ID or app is invalid.
49+
50+
.. _Delete an Instance ID: https://firebase.google.com/support/privacy\
51+
/manage-iids#delete_an_instance_id
4852
"""
4953
_get_iid_service(app).delete_instance_id(instance_id)
5054

firebase_admin/messaging.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,11 @@ class WebpushNotification(object):
321321
notification replaces an old one (optional).
322322
require_interaction: A boolean indicating whether a notification should remain active
323323
until the user clicks or dismisses it, rather than closing automatically (optional).
324-
silent: True to indicate that the notification should be silent (optional).
324+
silent: ``True`` to indicate that the notification should be silent (optional).
325325
tag: An identifying tag on the notification (optional).
326326
timestamp_millis: A timestamp value in milliseconds on the notification (optional).
327327
vibrate: A vibration pattern for the device's vibration hardware to emit when the
328-
notification fires (optional). THe pattern is specified as an integer array.
328+
notification fires (optional). The pattern is specified as an integer array.
329329
custom_data: A dict of custom key-value pairs to be included in the notification
330330
(optional)
331331

0 commit comments

Comments
 (0)