From ff239e7c90a34aedc72771e9b1f10dc17b8eae98 Mon Sep 17 00:00:00 2001 From: Risto Lahtela Date: Tue, 27 Aug 2019 13:01:40 +0300 Subject: [PATCH] Updated APIv5 DataExtension API (markdown) --- APIv5---DataExtension-API.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/APIv5---DataExtension-API.md b/APIv5---DataExtension-API.md index 1d0b6ee..61a981f 100644 --- a/APIv5---DataExtension-API.md +++ b/APIv5---DataExtension-API.md @@ -451,23 +451,19 @@ These annotations can be used to add information structures. They might have dif ### `@GroupProvider` -> `@GroupProvider` will be included in a future update for DataExtension API. +**Speciality:** Multiple `Group`s the player is in. Any providers with `Group` parameter will be called with the groups that this method provides (Not implemented yet). -**Speciality:** Multiple `Group`s the player is in. Any providers with `Group` parameter will be called with the groups that this method provides. +- Requires `DATA_EXTENSION_GROUPS` capability
Limitations and Additional data -- There can only be one GroupProvider per DataExtension - If you need multiple kinds of groups, create another `DataExtension` class. - Method requires UUID or String as method parameter. -- Does not work with `@Tab` annotations +- Group names over 50 characters will be truncated Plan will construct following from given group data: - Players in different groups are counted -- Additional data given by `Group` parameter methods about each group. -- Additional data about players is grouped based on groups. -- Additional data is displayed under a dropdown of the group.
@@ -475,29 +471,26 @@ Plan will construct following from given group data: ``` @GroupProvider( - text* = "Jobs", - description = "What jobs the player has", - priority = 5, + text = "Jobs", + groupColor = Color.NONE iconName = "question", iconFamily = Family.SOLID, - iconColor = Color.NONE ) -public String[] playerJobs(UUID playerUUID) {...} +public String[] playerJobs(UUID playerUUID) { + return new String[]{"Mason", "Woodcutter"} +} ``` -- `text` - Text that appears next to the value on Player's page, for example "Jobs: None" -- `description` - Text that appears when hovering over the value -- `priority` - Ordering number, highest value is placed top most +- `text` - Text that appears next to the value, for example "Jobs: None" +- `groupColor` - Color of the icon or table that appears near the groups - `iconName` - Icon names can be found from https://fontawesome.com/icons?d=gallery&m=free - `iconFamily` - Icon family should match details on the site above -- `iconColor` - Color of the icon that appears next to the value +
### `@TableProvider` -> `@TableProvider` will be included in the second update for DataExtension API. - **Speciality:** Table structures. - Requires `DATA_EXTENSION_TABLES` capability