... | ... | @@ -8,6 +8,7 @@ Annotations can be used to give the name, author, description and constraints fo |
|
|
### ModuleName
|
|
|
Used to give the name of the module. The name will also be used in lowercase for any API.ai actions you create.
|
|
|
Without a name the AIModule will not load!
|
|
|
|
|
|
**Package:** `be.maximvdw.qaplugin.api.annotations.ModuleName`
|
|
|
|
|
|
#### Example usage
|
... | ... | @@ -22,6 +23,7 @@ public class MyModule extends AIModule{ |
|
|
|
|
|
### ModuleAuthor
|
|
|
Used to give the author name of the module.
|
|
|
|
|
|
**Package:** `be.maximvdw.qaplugin.api.annotations.ModuleAuthor`
|
|
|
|
|
|
#### Example usage
|
... | ... | @@ -37,6 +39,7 @@ public class MyModule extends AIModule{ |
|
|
|
|
|
### ModuleDescription
|
|
|
Used to give description to the module.
|
|
|
|
|
|
**Package:** `be.maximvdw.qaplugin.api.annotations.ModuleDescription`
|
|
|
|
|
|
#### Example usage
|
... | ... | @@ -51,6 +54,7 @@ public class MyModule extends AIModule{ |
|
|
|
|
|
### ModuleVersion
|
|
|
Used to give the version of the module.
|
|
|
|
|
|
**Package:** `be.maximvdw.qaplugin.api.annotations.ModuleVersion`
|
|
|
|
|
|
#### Example usage
|
... | ... | @@ -65,6 +69,7 @@ public class MyModule extends AIModule{ |
|
|
```
|
|
|
### ModuleConstraints
|
|
|
When combining multiple `ModuleConstraint`'s together user this.
|
|
|
|
|
|
**Package:** `be.maximvdw.qaplugin.api.annotations.ModuleConstraints`
|
|
|
#### Example usage
|
|
|
```java
|
... | ... | @@ -84,6 +89,7 @@ This is a rule you add to an AIModule. There are multiple types of rules/constra |
|
|
the AIModule will not load.
|
|
|
|
|
|
It is used to require specific dependencies, versions ,... .
|
|
|
|
|
|
**Package:** `be.maximvdw.qaplugin.api.annotations.ModuleConstraint`
|
|
|
|
|
|
#### Constraint types
|
... | ... | @@ -91,6 +97,7 @@ These are the available constraint types you can check for. |
|
|
|
|
|
##### PLUGIN
|
|
|
Checks if a specific plugin is loaded
|
|
|
|
|
|
**Example:** Check for a plugin called "Essentials"
|
|
|
|
|
|
```java
|
... | ... | @@ -106,6 +113,7 @@ public class MyModule extends AIModule{ |
|
|
##### PLUGIN_VERSION
|
|
|
Checks if the version (string) of the plugin *starts with* a 'value'.
|
|
|
Requires you have set a PLUGIN constraint as well!
|
|
|
|
|
|
**Example:** Will check if the version of Essentials starts with "1."
|
|
|
|
|
|
```java
|
... | ... | @@ -124,6 +132,7 @@ public class MyModule extends AIModule{ |
|
|
##### PLUGIN_MAIN
|
|
|
Checks if the "main" class matches the one you provided in the value.
|
|
|
Requires you have set a PLUGIN constraint as well!
|
|
|
|
|
|
**Example:** Will check if the main class of QAPlugin is "be.maximvdw.qaplugin.QAPlugin"
|
|
|
|
|
|
```java
|
... | ... | @@ -142,6 +151,7 @@ public class MyModule extends AIModule{ |
|
|
##### PLUGIN_VERSION_IS_LOWER
|
|
|
Checks if the major.minor.build version is lower.
|
|
|
Requires you have set a PLUGIN constraint as well!
|
|
|
|
|
|
**Example:** Make sure the version is lower than 2.0.0
|
|
|
|
|
|
```java
|
... | ... | @@ -160,6 +170,7 @@ public class MyModule extends AIModule{ |
|
|
##### PLUGIN_VERSION_IS_HIGHER
|
|
|
Checks if the major.minor.build version is higher.
|
|
|
Requires you have set a PLUGIN constraint as well!
|
|
|
|
|
|
**Example:** Make sure the version is higher than 2.0.0
|
|
|
|
|
|
```java
|
... | ... | |