File tree 3 files changed +14
-10
lines changed
3 files changed +14
-10
lines changed Original file line number Diff line number Diff line change 44
44
45
45
46
46
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.
48
48
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,
52
52
specify the ``url`` parameter.
53
53
54
54
Args:
@@ -350,7 +350,7 @@ def listen(self, callback):
350
350
"""Registers the ``callback`` function to receive realtime updates.
351
351
352
352
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 .
354
354
355
355
This API is based on the event streaming support available in the Firebase REST API. Each
356
356
call to ``listen()`` starts a new HTTP connection and a background thread. This is an
Original file line number Diff line number Diff line change @@ -33,10 +33,11 @@ def _get_iid_service(app):
33
33
34
34
35
35
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.
37
37
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.
40
41
41
42
Args:
42
43
instance_id: A non-empty instance ID string.
@@ -45,6 +46,9 @@ def delete_instance_id(instance_id, app=None):
45
46
Raises:
46
47
InstanceIdError: If an error occurs while invoking the backend instance ID service.
47
48
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
48
52
"""
49
53
_get_iid_service (app ).delete_instance_id (instance_id )
50
54
Original file line number Diff line number Diff line change @@ -321,11 +321,11 @@ class WebpushNotification(object):
321
321
notification replaces an old one (optional).
322
322
require_interaction: A boolean indicating whether a notification should remain active
323
323
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).
325
325
tag: An identifying tag on the notification (optional).
326
326
timestamp_millis: A timestamp value in milliseconds on the notification (optional).
327
327
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.
329
329
custom_data: A dict of custom key-value pairs to be included in the notification
330
330
(optional)
331
331
You can’t perform that action at this time.
0 commit comments