Add notif dict docs
This commit is contained in:
pare
4b747886b9
commit
caba9c5467
S'han modificat 2 arxius amb 23 adicions i 1 eliminacions
|
@ -546,6 +546,26 @@ Push subscription dicts
|
||||||
# if webpushes have been requested for those events.
|
# if webpushes have been requested for those events.
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Push notification dicts
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
.. _push notification dict:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
mastodon.push_subscription_decrypt_push(...)
|
||||||
|
# Returns the following dictionary
|
||||||
|
{
|
||||||
|
'access_token': # Access token that can be used to access the API as the
|
||||||
|
# notified user
|
||||||
|
'body': # Text body of the notification
|
||||||
|
'icon': # URL to an icon for the notification
|
||||||
|
'notification_id': # ID that can be passed to notification() to get the full
|
||||||
|
# notification object,
|
||||||
|
'notification_type': # 'mention', 'reblog', 'follow' or 'favourite'
|
||||||
|
'preferred_locale': # The users preferred locale
|
||||||
|
'title': # Title for the notification
|
||||||
|
}
|
||||||
|
|
||||||
App registration and user authentication
|
App registration and user authentication
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
Before you can use the mastodon API, you have to register your
|
Before you can use the mastodon API, you have to register your
|
||||||
|
|
|
@ -132,6 +132,7 @@ class Mastodon:
|
||||||
__DICT_VERSION_ACTIVITY = "2.1.2"
|
__DICT_VERSION_ACTIVITY = "2.1.2"
|
||||||
__DICT_VERSION_REPORT = "1.1.0"
|
__DICT_VERSION_REPORT = "1.1.0"
|
||||||
__DICT_VERSION_PUSH = "2.4.0"
|
__DICT_VERSION_PUSH = "2.4.0"
|
||||||
|
__DICT_VERSION_PUSH_NOTIF = "2.4.0"
|
||||||
|
|
||||||
###
|
###
|
||||||
# Registering apps
|
# Registering apps
|
||||||
|
@ -1609,13 +1610,14 @@ class Mastodon:
|
||||||
|
|
||||||
return priv_dict, pub_dict
|
return priv_dict, pub_dict
|
||||||
|
|
||||||
|
@api_version("2.4.0", "2.4.0", __DICT_VERSION_PUSH_NOTIF)
|
||||||
def push_subscription_decrypt_push(self, data, decrypt_params, encryption_header, crypto_key_header):
|
def push_subscription_decrypt_push(self, data, decrypt_params, encryption_header, crypto_key_header):
|
||||||
"""
|
"""
|
||||||
Decrypts `data` received in a webpush request. Requires the private key dict
|
Decrypts `data` received in a webpush request. Requires the private key dict
|
||||||
from `push_subscription_generate_keys()`_ (`decrypt_params`) as well as the
|
from `push_subscription_generate_keys()`_ (`decrypt_params`) as well as the
|
||||||
Encryption and server Crypto-Key headers from the received webpush
|
Encryption and server Crypto-Key headers from the received webpush
|
||||||
|
|
||||||
Returns the decoded webpush.
|
Returns the decoded webpush as a `push notification dict`_.
|
||||||
"""
|
"""
|
||||||
salt = self.__decode_webpush_b64(encryption_header.split("salt=")[1].strip())
|
salt = self.__decode_webpush_b64(encryption_header.split("salt=")[1].strip())
|
||||||
dhparams = self.__decode_webpush_b64(crypto_key_header.split("dh=")[1].split(";")[0].strip())
|
dhparams = self.__decode_webpush_b64(crypto_key_header.split("dh=")[1].split(";")[0].strip())
|
||||||
|
|
Loading…
Referencia en una nova incidència