comparison sat/plugins/plugin_xep_0060.py @ 3860:e417c478b488

plugin XEP-0060, tools (utils): doc/type hints
author Goffi <goffi@goffi.org>
date Wed, 20 Jul 2022 17:18:17 +0200
parents 3ef988734869
children c3e6c54660da
comparison
equal deleted inserted replaced
3859:3ef988734869 3860:e417c478b488
723 723
724 @param service (JID, None): pubsub service. 724 @param service (JID, None): pubsub service.
725 @param node (str): node id. 725 @param node (str): node id.
726 @param max_items (int): optional limit on the number of retrieved items. 726 @param max_items (int): optional limit on the number of retrieved items.
727 @param item_ids (list[str]): identifiers of the items to be retrieved (can't be 727 @param item_ids (list[str]): identifiers of the items to be retrieved (can't be
728 used with rsm_request). 728 used with rsm_request). If requested items don't exist, they won't be
729 returned, meaning that we can have an empty list as result (NotFound
730 exception is NOT raised).
729 @param sub_id (str): optional subscription identifier. 731 @param sub_id (str): optional subscription identifier.
730 @param rsm_request (rsm.RSMRequest): RSM request data 732 @param rsm_request (rsm.RSMRequest): RSM request data
731 @return: a deferred couple (list[dict], dict) containing: 733 @return: a deferred couple (list[dict], dict) containing:
732 - list of items 734 - list of items
733 - metadata with the following keys: 735 - metadata with the following keys: