/
ExtensionDefinition.js
83 lines (72 loc) · 2.1 KB
/
ExtensionDefinition.js
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
/* API Version - 3.1.2 */
/**
* Base class for defining any kind of extension for Bitwig Studio.
*/
function ExtensionDefinition() {}
/**
* The name of the extension.
*
* @return {string}
*/
ExtensionDefinition.prototype.getName = function() {};
/**
* The author of the extension.
*
* @return {string}
*/
ExtensionDefinition.prototype.getAuthor = function() {};
/**
* The version of the extension.
*
* @return {string}
*/
ExtensionDefinition.prototype.getVersion = function() {};
/**
* A unique id that identifies this extension.
*
* @return {java.util.UUID}
*/
ExtensionDefinition.prototype.getId = function() {};
/**
* The minimum API version number that this extensions requires.
*
* @return {int}
*/
ExtensionDefinition.prototype.getRequiredAPIVersion = function() {};
/**
* Is this extension is using Beta APIs?
*
* Beta APIs are still on development and might not be available in a future version of Bitwig Studio.
*
* Turning this flag to true, will flag your extension as being a beta extension which might not work after
* updating Bitwig Studio.
*
* @return {boolean} true if the extension wants to use Beta APIs.
*/
ExtensionDefinition.prototype.isUsingBetaAPI = function() {};
/**
* Gets a remote URI or a path within the extension's jar file where documentation for this extension can
* be found or null if there is none. If the path is not a URI then it is assumed to be a path below the directory
* "Documentation" within the extension's jar file.
*
* @return {string}
*/
ExtensionDefinition.prototype.getHelpFilePath = function() {};
/**
* If true then this extension should fail when it calls a deprecated method in the API. This is useful
* during development.
*
* @return {boolean}
*/
ExtensionDefinition.prototype.shouldFailOnDeprecatedUse = function() {};
/**
* An e-mail address that can be used to contact the author of this extension if a problem is detected with
* it or null if none.
*
* @return {string}
*/
ExtensionDefinition.prototype.getErrorReportingEMail = function() {};
/**
* @return {string}
*/
ExtensionDefinition.prototype.toString = function() {};