o h=|@s,ddlmZddlmZGdddeZdS))BaseAPI)InvalidDataErrorc@s>eZdZddddddddddddddddddddddddifddZdddddddddddddifddZddddddddddddddddddddddddifdd Zddddddddddddif d d Zdddddddddddddddddddddddddifd d Zddddddddddddif ddZgdfddZ dS)FCMNotificationNFxcCs|jdid|gd|d|d|d|d|d|d|d | d | d | d | d | d|d|d|d|d|d|d|d|d|d|d||}||g||S)a- Send push notification to a single device Args: registration_id (list, optional): FCM device registration ID message_body (str, optional): Message string to display in the notification tray message_title (str, optional): Message title to display in the notification tray message_icon (str, optional): Icon that apperas next to the notification sound (str, optional): The sound file name to play. Specify "Default" for device default sound. condition (str, optiona): Topic condition to deliver messages to collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to `None`. delay_while_idle (bool, optional): deprecated time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to `None` which uses the FCM default of 4 weeks. restricted_package_name (str, optional): Name of package low_priority (bool, optional): Whether to send notification with the low priority flag. Defaults to `False`. dry_run (bool, optional): If `True` no message will be sent but request will be tested. data_message (dict, optional): Custom key-value pairs click_action (str, optional): Action associated with a user click on the notification badge (str, optional): Badge of notification color (str, optional): Color of the icon tag (str, optional): Group notification by tag body_loc_key (str, optional): Indicates the key to the body string for localization body_loc_args (list, optional): Indicates the string value to replace format specifiers in body string for localization title_loc_key (str, optional): Indicates the key to the title string for localization title_loc_args (list, optional): Indicates the string value to replace format specifiers in title string for localization content_available (bool, optional): Inactive client app is awoken android_channel_id (str, optional): Starting in Android 8.0 (API level 26), all notifications must be assigned to a channel. For each channel, you can set the visual and auditory behavior that is applied to all notifications in that channel. Then, users can change these settings and decide which notification channels from your app should be intrusive or visible at all. timeout (int, optional): set time limit for the request extra_notification_kwargs (dict, optional): More notification keyword arguments extra_kwargs (dict, optional): More keyword arguments Returns: dict: Response from FCM server (`multicast_id`, `success`, `failure`, `canonical_ids`, `results`) Raises: AuthenticationError: If :attr:`api_key` is not set or provided or there is an error authenticating the sender. FCMServerError: Internal server error or timeout error on Firebase cloud messaging server InvalidDataError: Invalid data provided InternalPackageError: Mostly from changes in the response of FCM, contact the project owner to resolve the issue registration_ids message_body message_title message_iconsound condition collapse_keydelay_while_idle time_to_liverestricted_package_name low_prioritydry_run data_message click_actionbadgecolortag body_loc_key body_loc_args title_loc_keytitle_loc_argsandroid_channel_idcontent_availableextra_notification_kwargsN parse_payload send_requestparse_responses)selfregistration_idrrr r r r r rrrrrrrrrrrrrrrtimeoutr extra_kwargspayloadrrQ/var/www/html/magazine_api/magazine_env/lib/python3.10/site-packages/pyfcm/fcm.pynotify_single_devicesh S       z$FCMNotification.notify_single_devicecCsT|durtd|jd|g|||||||| | d| | d |}||g| |S)a Send push message to a single device Args: registration_id (list, optional): FCM device registration ID condition (str, optiona): Topic condition to deliver messages to collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to `None`. delay_while_idle (bool, optional): deprecated time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to `None` which uses the FCM default of 4 weeks. restricted_package_name (str, optional): Name of package low_priority (bool, optional): Whether to send notification with the low priority flag. Defaults to `False`. dry_run (bool, optional): If `True` no message will be sent but request will be tested. data_message (dict, optional): Custom key-value pairs content_available (bool, optional): Inactive client app is awoken android_channel_id (str, optional): Starting in Android 8.0 (API level 26), all notifications must be assigned to a channel. For each channel, you can set the visual and auditory behavior that is applied to all notifications in that channel. Then, users can change these settings and decide which notification channels from your app should be intrusive or visible at all. timeout (int, optional): set time limit for the request extra_notification_kwargs (dict, optional): More notification keyword arguments extra_kwargs (dict, optional): More keyword arguments Returns: dict: Response from FCM server (`multicast_id`, `success`, `failure`, `canonical_ids`, `results`) Raises: AuthenticationError: If :attr:`api_key` is not set or provided or there is an error authenticating the sender. FCMServerError: Internal server error or timeout error on Firebase cloud messaging server InvalidDataError: Invalid data provided InternalPackageError: Mostly from changes in the response of FCM, contact the project owner to resolve the issue NzInvalid registration IDT) rr r r rrrrrrremove_notificationrrr)rr r!r")r#r$r r r rrrrrrrr%rr&r'rrr(single_device_data_messagevs*7z*FCMNotification.single_device_data_messagecCst|ts tdg}||}|D]U}||jdid|d|d|d|d|d|d|d |d | d | d | d | d| d|d|d|d|d|d|d|d|d|d|d||q||||S)a^ Sends push notification to multiple devices, can send to over 1000 devices Args: registration_ids (list, optional): FCM device registration IDs message_body (str, optional): Message string to display in the notification tray message_title (str, optional): Message title to display in the notification tray message_icon (str, optional): Icon that apperas next to the notification sound (str, optional): The sound file name to play. Specify "Default" for device default sound. condition (str, optiona): Topic condition to deliver messages to collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to `None`. delay_while_idle (bool, optional): deprecated time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to `None` which uses the FCM default of 4 weeks. restricted_package_name (str, optional): Name of package low_priority (bool, optional): Whether to send notification with the low priority flag. Defaults to `False`. dry_run (bool, optional): If `True` no message will be sent but request will be tested. data_message (dict, optional): Custom key-value pairs click_action (str, optional): Action associated with a user click on the notification badge (str, optional): Badge of notification color (str, optional): Color of the icon tag (str, optional): Group notification by tag body_loc_key (str, optional): Indicates the key to the body string for localization body_loc_args (list, optional): Indicates the string value to replace format specifiers in body string for localization title_loc_key (str, optional): Indicates the key to the title string for localization title_loc_args (list, optional): Indicates the string value to replace format specifiers in title string for localization content_available (bool, optional): Inactive client app is awoken android_channel_id (str, optional): Starting in Android 8.0 (API level 26), all notifications must be assigned to a channel. For each channel, you can set the visual and auditory behavior that is applied to all notifications in that channel. Then, users can change these settings and decide which notification channels from your app should be intrusive or visible at all. timeout (int, optional): set time limit for the request extra_notification_kwargs (dict, optional): More notification keyword arguments extra_kwargs (dict, optional): More keyword arguments Returns: dict: Response from FCM server (`multicast_id`, `success`, `failure`, `canonical_ids`, `results`) Raises: AuthenticationError: If :attr:`api_key` is not set or provided or there is an error authenticating the sender. FCMServerError: Internal server error or timeout error on Firebase cloud messaging server InvalidDataError: Invalid data provided InternalPackageError: JSON parsing error, mostly from changes in the response of FCM, create a new github issue to resolve it. )Invalid registration IDs (should be list)rrrr r r r r rrrrrrrrrrrrrrrrNr isinstancelistrregistration_id_chunksappendr r!r")r#rrrr r r r r rrrrrrrrrrrrrrrr%rr&payloadsr0rrr(notify_multiple_devicessr Q        z'FCMNotification.notify_multiple_devicescCsnt|ts tdg}||}|D]}||jd||||||||| | d| d | q||| |S)a' Sends push message to multiple devices, can send to over 1000 devices Args: registration_ids (list, optional): FCM device registration IDs condition (str, optiona): Topic condition to deliver messages to collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to `None`. delay_while_idle (bool, optional): deprecated time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to `None` which uses the FCM default of 4 weeks. restricted_package_name (str, optional): Name of package low_priority (bool, optional): Whether to send notification with the low priority flag. Defaults to `False`. dry_run (bool, optional): If `True` no message will be sent but request will be tested. data_message (dict, optional): Custom key-value pairs content_available (bool, optional): Inactive client app is awoken timeout (int, optional): set time limit for the request extra_notification_kwargs (dict, optional): More notification keyword arguments extra_kwargs (dict, optional): More keyword arguments Returns: dict: Response from FCM server (`multicast_id`, `success`, `failure`, `canonical_ids`, `results`) Raises: AuthenticationError: If :attr:`api_key` is not set or provided or there is an error authenticating the sender. FCMServerError: Internal server error or timeout error on Firebase cloud messaging server InvalidDataError: Invalid data provided InternalPackageError: JSON parsing error, mostly from changes in the response of FCM, create a new github issue to resolve it. r,T) rr r r rrrrrrr*rNrr-)r#rr r r rrrrrrr%rr&r2r0rrr(multiple_devices_data_message:s. 1   z-FCMNotification.multiple_devices_data_messagecCs|jdid|d|d|d|d|d|d|d|d | d | d | d | d | d|d|d|d|d|d|d|d|d|d|d||}||g||S)a[ Sends push notification to multiple devices subscribed to a topic Args: topic_name (str, optional): Name of the topic to deliver messages to message_body (str, optional): Message string to display in the notification tray message_title (str, optional): Message title to display in the notification tray message_icon (str, optional): Icon that apperas next to the notification sound (str, optional): The sound file name to play. Specify "Default" for device default sound. condition (str, optiona): Topic condition to deliver messages to collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to `None`. delay_while_idle (bool, optional): deprecated time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to `None` which uses the FCM default of 4 weeks. restricted_package_name (str, optional): Name of package low_priority (bool, optional): Whether to send notification with the low priority flag. Defaults to `False`. dry_run (bool, optional): If `True` no message will be sent but request will be tested. data_message (dict, optional): Custom key-value pairs click_action (str, optional): Action associated with a user click on the notification badge (str, optional): Badge of notification color (str, optional): Color of the icon tag (str, optional): Group notification by tag body_loc_key (str, optional): Indicates the key to the body string for localization body_loc_args (list, optional): Indicates the string value to replace format specifiers in body string for localization title_loc_key (str, optional): Indicates the key to the title string for localization title_loc_args (list, optional): Indicates the string value to replace format specifiers in title string for localization content_available (bool, optional): Inactive client app is awoken android_channel_id (str, optional): Starting in Android 8.0 (API level 26), all notifications must be assigned to a channel. For each channel, you can set the visual and auditory behavior that is applied to all notifications in that channel. Then, users can change these settings and decide which notification channels from your app should be intrusive or visible at all. timeout (int, optional): set time limit for the request extra_notification_kwargs (dict, optional): More notification keyword arguments extra_kwargs (dict, optional): More keyword arguments Returns: dict: Response from FCM server (`multicast_id`, `success`, `failure`, `canonical_ids`, `results`) Raises: AuthenticationError: If :attr:`api_key` is not set or provided or there is an error authenticating the sender. FCMServerError: Internal server error or timeout error on Firebase cloud messaging server InvalidDataError: Invalid data provided InternalPackageError: JSON parsing error, mostly from changes in the response of FCM, create a new github issue to resolve it. topic_namer rrr r r r rrrrrrrrrrrrrrrrNrr)r#r5rrr r r r r rrrrrrrrrrrrrrrr%rr&r'rrr(notify_topic_subscriberssh Q       z(FCMNotification.notify_topic_subscriberscCsL| duri} |jd||||||||| | d| d | }||g| |S)a Sends data notification to multiple devices subscribed to a topic Args: topic_name (topic_name): Name of the topic to deliver messages to condition (condition): Topic condition to deliver messages to A topic name is a string that can be formed with any character in [a-zA-Z0-9-_.~%] data_message (dict): Data message payload to send alone or with the notification message Keyword Args: collapse_key (str, optional): Identifier for a group of messages that can be collapsed so that only the last message gets sent when delivery can be resumed. Defaults to ``None``. delay_while_idle (bool, optional): If ``True`` indicates that the message should not be sent until the device becomes active. time_to_live (int, optional): How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks. Defaults to ``None`` which uses the FCM default of 4 weeks. low_priority (boolean, optional): Whether to send notification with the low priority flag. Defaults to ``False``. restricted_package_name (str, optional): Package name of the application where the registration IDs must match in order to receive the message. Defaults to ``None``. dry_run (bool, optional): If ``True`` no message will be sent but request will be tested. Returns: :tuple:`multicast_id(long), success(int), failure(int), canonical_ids(int), results(list)`: Response from FCM server. Raises: AuthenticationError: If :attr:`api_key` is not set or provided or there is an error authenticating the sender. FCMServerError: Internal server error or timeout error on Firebase cloud messaging server InvalidDataError: Invalid data provided InternalPackageError: JSON parsing error, mostly from changes in the response of FCM, create a new github issue to resolve it. NT) r5r r r rrrrrrr*rrr)r#r5r r r rrrrrrr%rr&r'rrr(topic_subscribers_data_messages&1  z.FCMNotification.topic_subscribers_data_messagecs fdd|D}j||dS)a( Sends push notification to multiple devices with personalized templates Args: params_list (list): list of parameters ( the sames as notify_multiple_devices) timeout (int, optional): set time limit for the request csg|]}|qSr)r ).0paramsr#rr( >szAFCMNotification.async_notify_multiple_devices..)r2r%)Zsend_async_request)r#Z params_listr%r2rr;r(async_notify_multiple_devices4s z-FCMNotification.async_notify_multiple_devices) __name__ __module__ __qualname__r)r+r3r4r6r7r=rrrr(rs q P w K n CrN)Zbaseapirerrorsrrrrrr(s