Upstream
/
Plan
mirror of https://github.com/plan-player-analytics/Plan.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated APIv5 (markdown)

Risto Lahtela 2019-04-10 17:27:31 +03:00
parent 6e5bad146c
commit 20c86559c1
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
APIv5.md

@ -11,10 +11,6 @@ API module Version | Plan Version
-- | --
0.0.3 | 4.8.0
## Checking if some part of an API is available
> This section is about API v0.0.4 which is set for release with 4.8.2
<details>
<summary>API module dependency information</summary>
@ -45,11 +41,16 @@ Remember to add `"Plan"` as a softdependency to your plugin information (plugin.
</details>
<details>
<summary>Checking if the API supports a capability</summary>
> All Plan API related things should be done in it's own class to avoid NoClassDefFoundError if Plan is not installed.
- `CapabilityService` allows you to ensure that Plan version on the server has all the API capabilities you need available.
- All Plan API related things should be done in it's own class to avoid NoClassDefFoundError if Plan is not installed. Below is an example of a capability check.
## Checking if some capability of the API is available
> This section is about API v0.0.4 which is set for release with 4.8.2
`CapabilityService#hasCapability(String)` allows you to ensure that Plan version on the server has all the API capabilities you need.
<details>
<summary>Example usage</summary>
```
class ClassWhereYouDoAllPlanThings {