Skip to content

Commit

Permalink
More saved search docs
Browse files Browse the repository at this point in the history
  • Loading branch information
urschrei committed Dec 30, 2018
1 parent 316e8b0 commit 75e1b1e
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,14 +310,36 @@ Pyzotero allows you to retrieve, delete, or modify saved searches:
Create a new saved search. `conditions` is a list of one or more dicts, each of which must contain the following three string keys:
`condition`, `operator`, `value`. See the `documentation <https://www.zotero.org/support/dev/web_api/v3/write_requests#saved_search_requests>`_ for an example.

:param str name: the name of the search
:param list conditions: one or more dicts containing search conditions and operators
:rtype: None

.. py:method:: Zotero.delete_saved_search(search_keys)
Delete one or more saved searches. `search_keys` is a list of one or more search keys. These can be retrievd using :py:meth:`Zotero.searches()`

:param list search_keys: list of unique saved search keys
:rtype: None

.. py:method:: Zotero.show_operators()
Show available saved search operators

:rtype: str

.. py:method:: Zotero.show_conditions()
Show available saved search conditions

:rtype: str

.. py:method:: Zotero.show_condition_operators(condition)
Show available operators for a given saved search condition

:param str condition: a valid saved search condition
:rtype: str


====================
Retrieving Files
Expand Down

0 comments on commit 75e1b1e

Please sign in to comment.