1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*
* The MIT License (MIT)
*
* Copyright (c) 2023 Daniél Kerkmann <daniel@kerkmann.dev>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/// Gets information about the available `AnkiConnect` APIs.
///
/// The request supports the following params:
/// - [`scopes`] - An array of scopes to get reflection information about. The only currently supported value is `"actions"`.
/// - [`actions`] - Either `null` or an array of API method names to check for. If the value is `null`, the result will list all the available API actions. If the value is an array of strings, the result will only contain actions which were in this array.
///
/// The result will contain a list of which scopes were used and a value for each scope.
/// For example, the `"actions"` scope will contain a `"actions"` property which contains a list of supported action names.
///
/// [`scopes`]: api_reflect::ApiReflectRequest::scopes
/// [`actions`]: api_reflect::ApiReflectRequest::actions
/// Export deck in `.apkg` format.
///
/// The optional property `include_sched` (default is `false`) can be specified to include the cards' scheduling data.
///
/// Returns `true` if successful or `false` otherwise.
/// Gets the active profile.
/// Gets the list of profiles.
/// Import a file in `.apkg` format into the collection.
///
/// Returns `true` if successful or `false` otherwise.
///
/// Note that the file path is relative to Anki's `collection.media` folder, not to the client sending the request.
/// Switches to a different profile.
/// Performs multiple actions in one request, returning an array with the response of each action (in the given order).
/// Reloads all data from the database.
/// Requests permission to use the API exposed by this plugin.
///
/// This method does not require the API key, and is the only one that accepts requests from any origin; the other methods only accept requests from trusted origins, which are listed under `webCorsOriginList` in the add-on config.
/// `localhost` is trusted by default.
///
/// Calling this method from an untrusted origin will display a popup in Anki asking the user whether they want to allow your origin to use the API; calls from trusted origins will return the result without displaying the popup. When denying permission, the user may also choose to ignore further permission requests from that origin. These origins end up in the `ignoreOriginList`, editable via the add-on config.
/// The result always contains the `permission` field, which in turn contains either the string `granted` or `denied`, corresponding to whether your origin is trusted. If your origin is trusted, the fields `require_api_key` (`true` if required) and `version` will also be returned.
/// This should be the first call you make to make sure that your application and Anki-Connect are able to communicate properly with each other. New versions of Anki-Connect are backwards compatible; as long as you are using actions which are available in the reported Anki-Connect version or earlier, everything should work fine.
/// Synchronizes the local Anki collections with `AnkiWeb`.
/// Gets the version of the API exposed by this plugin.
///
/// Currently, versions `1` through `6` are defined.