### Install Trello Java SDK
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/README.md
Add the Trello Java SDK as a dependency to your project's pom.xml file to begin using its functionalities.
```xml
io.sdks
trello-java-sdk
1.0.0
```
--------------------------------
### MyPrefsShowListGuide Fields and JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/my-prefs-show-list-guide.md
Details the 'Value' field of the MyPrefsShowListGuide class, which is an optional String representing a true or false state. Includes a JSON example of its structure.
```Java
MyPrefsShowListGuide
Fields:
Value: String (Optional) - Represents true or false.
getValue(): String
setValue(String value): void
```
```json
{
"value": "value0"
}
```
--------------------------------
### Trello Java SDK Utilities
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/README.md
Documentation for utility classes in the Trello Java SDK, including exception handling and helper functionalities.
```APIDOC
ApiException: Represents an exception that occurred during an API call.
ApiHelper: Provides helper methods for interacting with the Trello API.
FileWrapper: A utility class for file operations.
```
--------------------------------
### Trello Java SDK HTTP Components
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/README.md
Documentation for various HTTP-related interfaces and classes used in the Trello Java SDK. This includes headers, request and response handling, and callback mechanisms.
```APIDOC
Headers: Documentation for handling HTTP headers.
HttpCallback Interface: Defines the interface for handling HTTP callbacks.
HttpContext: Represents the context of an HTTP request or response.
HttpBodyRequest: Represents an HTTP request with a body.
HttpRequest: Represents an HTTP request.
HttpResponse: Represents an HTTP response.
HttpStringResponse: Represents an HTTP response containing a string body.
```
--------------------------------
### Trello Java SDK: Get Organizations Actions Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/organization.md
Example Java code demonstrating how to retrieve organization actions using the Trello Java SDK. It shows how to set parameters and handle asynchronous responses.
```Java
String idOrg = "idOrg0";
String key = "key0";
String token = "token6";
String filter = "all";
String fields = "all";
String limit = "50";
String format = "list";
String page = "0";
String memberFields = "avatarHash, fullName, initials and username";
String memberCreatorFields = "avatarHash, fullName, initials and username";
organizationController.getOrganizationsActionsByIdOrgAsync(idOrg, key, token, null, null, filter, fields, limit, format, null, null, page, null, null, memberFields, null, memberCreatorFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Initialize Trello API Client
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/README.md
Initialize the Trello API client by providing API key and token credentials. The client can be configured with custom HTTP client settings, such as timeouts.
```java
import com.trello.TrelloClient;
import com.trello.authentication.ApiKeyModel;
import com.trello.authentication.ApiTokenModel;
import com.trello.exceptions.ApiException;
import java.io.IOException;
TrelloClient client = new TrelloClient.Builder()
.httpClientConfig(configBuilder -> configBuilder
.timeout(0))
.apiKeyCredentials(new ApiKeyModel.Builder(
"key"
)
.build())
.apiTokenCredentials(new ApiTokenModel.Builder(
"token"
)
.build())
.build();
```
--------------------------------
### Trello Java SDK: Get Members Actions Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/member.md
Example of how to asynchronously retrieve member actions using the Trello Java SDK. It demonstrates setting parameters and handling success and failure callbacks.
```Java
String idMember = "idMember6";
String key = "key0";
String token = "token6";
String filter = "all";
String fields = "all";
String limit = "50";
String format = "list";
String page = "0";
String memberFields = "avatarHash, fullName, initials and username";
String memberCreatorFields = "avatarHash, fullName, initials and username";
memberController.getMembersActionsByIdMemberAsync(idMember, key, token, null, null, filter, fields, limit, format, null, null, page, null, null, memberFields, null, memberCreatorFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Trello Java SDK - Get Member Boards Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/member.md
Example Java code demonstrating how to call the `getMembersBoardsByIdMemberAsync` method with various parameters and handle the asynchronous response.
```java
String idMember = "idMember6";
String key = "key0";
String token = "token6";
String filter = "all";
String fields = "all";
String actionsLimit = "50";
String actionsFormat = "list";
String actionFields = "all";
String memberships = "none";
String organizationFields = "name and displayName";
String lists = "none";
memberController.getMembersBoardsByIdMemberAsync(idMember, key, token, filter, fields, null, null, actionsLimit, actionsFormat, null, actionFields, memberships, null, organizationFields, lists).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### PrefsMinutesBetweenSummaries JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-minutes-between-summaries.md
Provides an example of how PrefsMinutesBetweenSummaries might be represented in JSON format.
```JSON
{
"value": "value2"
}
```
--------------------------------
### MyPrefsShowSidebarActivity JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/my-prefs-show-sidebar-activity.md
An example of how MyPrefsShowSidebarActivity can be represented in JSON format, showing the 'value' field.
```JSON
{
"value": "value2"
}
```
--------------------------------
### Get Card Actions by ID Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/card.md
Example Java code demonstrating how to retrieve actions for a Trello card asynchronously using the Trello Java SDK. It shows how to set parameters and handle the asynchronous response.
```Java
String idCard = "idCard4";
String key = "key0";
String token = "token6";
String filter = "commentCard and updateCard:idList";
String fields = "all";
String limit = "50";
String format = "list";
String page = "0";
String memberFields = "avatarHash, fullName, initials and username";
String memberCreatorFields = "avatarHash, fullName, initials and username";
cardController.getCardsActionsByIdCardAsync(idCard, key, token, null, null, filter, fields, limit, format, null, null, page, null, null, memberFields, null, memberCreatorFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### PrefsGoogleAppsVersion JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-google-apps-version.md
An example of the PrefsGoogleAppsVersion structure represented in JSON format.
```JSON
{
"value": "value4"
}
```
--------------------------------
### PrefsCardCovers JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-card-covers.md
Provides an example of the PrefsCardCovers structure represented in JSON format.
```JSON
{
"value": "value8"
}
```
--------------------------------
### PrefsBackground JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-background.md
An example of how PrefsBackground is represented in JSON format.
```JSON
{
"value": "value4"
}
```
--------------------------------
### Example Usage: Get Boards Cards by Id Board by Filter Async
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/board.md
Demonstrates how to asynchronously fetch boards cards by board ID and filter using the Trello Java SDK. Includes placeholders for success and failure callback handlers.
```java
String idBoard = "idBoard2";
String filter = "filter4";
String key = "key0";
String token = "token6";
boardController.getBoardsCardsByIdBoardByFilterAsync(idBoard, filter, key, token).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### MembersCustomBoardBackgrounds JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/members-custom-board-backgrounds.md
An example of the MembersCustomBoardBackgrounds structure represented in JSON format.
```JSON
{
"brightness": "brightness2",
"file": "file6",
"tile": "tile2"
}
```
--------------------------------
### PrefsColorBlind JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-color-blind.md
An example of how PrefsColorBlind might be represented in JSON format.
```JSON
{
"value": "value6"
}
```
--------------------------------
### MembersBoardStars JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/members-board-stars.md
Provides an example of the MembersBoardStars structure represented in JSON format.
```JSON
{
"idBoard": "idBoard8",
"pos": "pos0"
}
```
--------------------------------
### PrefsInvitations JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-invitations.md
An example of how PrefsInvitations is represented in JSON format.
```JSON
{
"value": "value6"
}
```
--------------------------------
### PrefsLocale JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/prefs-locale.md
Provides an example of how the PrefsLocale object is represented in JSON format.
```JSON
{
"value": "value6"
}
```
--------------------------------
### Initialize BatchController
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/batch.md
Demonstrates how to get an instance of the BatchController from the Trello client.
```Java
BatchController batchController = client.getBatchController();
```
--------------------------------
### Get Trello Card Stickers Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/card.md
Example of how to retrieve Trello card stickers by card ID and sticker ID, with optional fields parameter, using the Java SDK.
```java
String idCard = "idCard4";
String idSticker = "idSticker4";
String key = "key0";
String token = "token6";
String fields = "all";
cardController.getCardsStickersByIdCardByIdStickerAsync(idCard, idSticker, key, token, fields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Trello Java SDK: Get Lists Actions Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/list.md
Example of how to call the getListsActionsByIdListAsync method in the Trello Java SDK, including success and failure callback handlers.
```Java
String idList = "idList4";
String key = "key0";
String token = "token6";
String filter = "all";
String fields = "all";
String limit = "50";
String format = "list";
String page = "0";
String memberFields = "avatarHash, fullName, initials and username";
String memberCreatorFields = "avatarHash, fullName, initials and username";
listController.getListsActionsByIdListAsync(idList, key, token, null, null, filter, fields, limit, format, null, null, page, null, null, memberFields, null, memberCreatorFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### TrelloClient Initialization
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/client.md
Demonstrates how to initialize the TrelloClient with custom HTTP client configuration and API key/token credentials.
```Java
import com.trello.TrelloClient;
import com.trello.authentication.ApiKeyModel;
import com.trello.authentication.ApiTokenModel;
import com.trello.exceptions.ApiException;
import java.io.IOException;
TrelloClient client = new TrelloClient.Builder()
.httpClientConfig(configBuilder -> configBuilder
.timeout(0))
.apiKeyCredentials(new ApiKeyModel.Builder(
"key"
)
.build())
.apiTokenCredentials(new ApiTokenModel.Builder(
"token"
)
.build())
.build();
```
--------------------------------
### Trello Java SDK: Get Boards Members Cards Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/board.md
Example usage of the getBoardsMembersCardsByIdBoardByIdMemberAsync method in the Trello Java SDK, demonstrating how to set parameters and handle asynchronous responses.
```Java
String idBoard = "idBoard2";
String idMember = "idMember6";
String key = "key0";
String token = "token6";
String attachmentFields = "all";
String memberFields = "avatarHash, fullName, initials and username";
String checklists = "none";
String boardFields = "name, desc, closed, idOrganization, pinned, url and prefs";
String listFields = "all";
String filter = "visible";
String fields = "all";
boardController.getBoardsMembersCardsByIdBoardByIdMemberAsync(idBoard, idMember, key, token, null, null, attachmentFields, null, memberFields, null, checklists, null, boardFields, null, listFields, filter, fields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Get Members Custom Board Backgrounds by Id Member Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/member.md
Example usage for asynchronously retrieving a member's custom board backgrounds using the Trello Java SDK.
```Java
String idMember = "idMember6";
String key = "key0";
String token = "token6";
String filter = "all";
memberController.getMembersCustomBoardBackgroundsByIdMemberAsync(idMember, key, token, filter).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Initialize BoardController
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/board.md
Demonstrates how to get an instance of the BoardController from the Trello client to interact with board-related API endpoints.
```java
BoardController boardController = client.getBoardController();
```
--------------------------------
### Trello Java SDK - Get Notifications Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/notification.md
Example of how to use the `getNotificationsByIdNotificationAsync` method in the Trello Java SDK to retrieve notifications, including setting various optional fields for detailed data retrieval.
```java
String idNotification = "idNotification0";
String key = "key0";
String token = "token6";
String fields = "all";
String memberCreatorFields = "avatarHash, fullName, initials and username";
String boardFields = "name";
String cardFields = "name";
String organizationFields = "displayName";
String memberFields = "avatarHash, fullName, initials and username";
notificationController.getNotificationsByIdNotificationAsync(idNotification, key, token, null, null, fields, null, memberCreatorFields, null, boardFields, null, null, cardFields, null, organizationFields, null, memberFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Trello SDK Action Retrieval Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/action.md
Example of how to retrieve actions using the Trello Java SDK, demonstrating asynchronous calls and callback handling for success and failure scenarios.
```Java
String idAction = "idAction6";
String key = "key0";
String token = "token6";
String fields = "all";
String memberFields = "avatarHash, fullName, initials and username";
String memberCreatorFields = "avatarHash, fullName, initials and username";
actionController.getActionsByIdActionAsync(idAction, key, token, null, null, fields, null, memberFields, null, memberCreatorFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Initialize CardController
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/card.md
Demonstrates how to obtain an instance of the CardController from the Trello client to manage card-related operations.
```Java
CardController cardController = client.getCardController();
```
--------------------------------
### Java SDK: Get Boards Cards by ID Board Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/board.md
Example of how to use the Trello Java SDK to retrieve cards for a specific board asynchronously. Demonstrates setting parameters and handling success and error callbacks.
```Java
String idBoard = "idBoard2";
String key = "key0";
String token = "token6";
String attachmentFields = "all";
String memberFields = "avatarHash, fullName, initials and username";
String checklists = "none";
String filter = "visible";
String fields = "all";
boardController.getBoardsCardsByIdBoardAsync(idBoard, key, token, null, null, attachmentFields, null, null, memberFields, null, checklists, null, null, null, filter, fields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Initialize OrganizationController
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/organization.md
Demonstrates how to get an instance of the OrganizationController from the Trello client to manage organization-related operations.
```java
OrganizationController organizationController = client.getOrganizationController();
```
--------------------------------
### Get Actions by ID and Field
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/action.md
Provides an example of retrieving action details from Trello by specifying the action ID and a specific field. This endpoint does not require authentication.
```Java
String idAction = "idAction6";
String field = "field6";
String key = "key0";
String token = "token6";
actionController.getActionsByIdActionByFieldAsync(idAction, field, key, token).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Initialize Webhook Controller
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/webhook.md
Initializes the WebhookController using the Trello client.
```Java
WebhookController webhookController = client.getWebhookController();
```
--------------------------------
### Get Members Cards by Id Member
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/member.md
Asynchronously retrieves a member's cards based on a specified filter. Includes example usage and error handling for API rejections.
```Java
String idMember = "idMember6";
String filter = "filter4";
String key = "key0";
String token = "token6";
memberController.getMembersCardsByIdMemberByFilterAsync(idMember, filter, key, token).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Get Board Actions by ID
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/board.md
Provides the API signature and example usage for retrieving actions associated with a specific Trello board. It details all available query parameters for filtering and pagination.
```APIDOC
CompletableFuture getBoardsActionsByIdBoardAsync(
final String idBoard,
final String key,
final String token,
final String entities,
final String display,
final String filter,
final String fields,
final String limit,
final String format,
final String since,
final String before,
final String page,
final String idModels,
final String member,
final String memberFields,
final String memberCreator,
final String memberCreatorFields)
Parameters:
- idBoard (String, Required): board_id
- key (String, Required): Generate your application key
- token (String, Required): Getting a token from a user
- entities (String, Optional): true or false
- display (String, Optional): true or false
- filter (String, Optional): all or a comma-separated list of: addAttachmentToCard, addChecklistToCard, addMemberToBoard, addMemberToCard, addMemberToOrganization, addToOrganizationBoard, commentCard, convertToCardFromCheckItem, copyBoard, copyCard, copyCommentCard, createBoard, createCard, createList, createOrganization, deleteAttachmentFromCard, deleteBoardInvitation, deleteCard, deleteOrganizationInvitation, disablePowerUp, emailCard, enablePowerUp, makeAdminOfBoard, makeNormalMemberOfBoard, makeNormalMemberOfOrganization, makeObserverOfBoard, memberJoinedTrello, moveCardFromBoard, moveCardToBoard, moveListFromBoard, moveListToBoard, removeChecklistFromCard, removeFromOrganizationBoard, removeMemberFromCard, unconfirmedBoardInvitation, unconfirmedOrganizationInvitation, updateBoard, updateCard, updateCard:closed, updateCard:desc, updateCard:idList, updateCard:name, updateCheckItemStateOnCard, updateChecklist, updateList, updateList:closed, updateList:name, updateMember or updateOrganization. Default: "all"
- fields (String, Optional): all or a comma-separated list of: data, date, idMemberCreator or type. Default: "all"
- limit (String, Optional): a number from 0 to 1000. Default: "50"
- format (String, Optional): One of: count, list or minimal. Default: "list"
- since (String, Optional): A date, null or lastView
- before (String, Optional): A date, or null
- page (String, Optional): Page * limit must be less than 1000. Default: "0"
- idModels (String, Optional): Only return actions related to these model ids
- member (String, Optional): true or false
- memberFields (String, Optional): all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username. Default: "avatarHash, fullName, initials and username"
- memberCreator (String, Optional): true or false
- memberCreatorFields (String, Optional): all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username. Default: "avatarHash, fullName, initials and username"
Response Type:
`void`
Example Usage:
String idBoard = "idBoard2";
String key = "key0";
String token = "token6";
String filter = "all";
String fields = "all";
String limit = "50";
String format = "list";
String page = "0";
String memberFields = "avatarHash, fullName, initials and username";
String memberCreatorFields = "avatarHash, fullName, initials and username";
boardController.getBoardsActionsByIdBoardAsync(idBoard, key, token, null, null, filter, fields, limit, format, null, null, page, null, null, memberFields, null, memberCreatorFields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
Errors:
| HTTP Status Code | Error Description | Exception Class |
| --- | --- | --- |
| 400 | Server rejection | `ApiException` |
```
--------------------------------
### Example Board JSON Structure
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/boards.md
Provides an example of how a Trello Board object is represented in JSON format, illustrating the structure and key-value pairs for board attributes.
```JSON
{
"closed": "closed2",
"desc": "desc2",
"idBoardSource": "idBoardSource2",
"idOrganization": "idOrganization8",
"keepFromSource": "keepFromSource6"
}
```
--------------------------------
### Initialize Label Controller
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/label.md
Demonstrates how to get an instance of the LabelController from the Trello client.
```java
LabelController labelController = client.getLabelController();
```
--------------------------------
### Get Cards Attachments by Id Card
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/card.md
Retrieves attachments for a given card asynchronously. Requires card ID, API key, token, and an optional fields parameter. Includes example usage and error handling.
```Java
cardController.getCardsAttachmentsByIdCardAsync(idCard, key, token, fields, null).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Get Lists by ID List and Field
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/list.md
Provides an example of retrieving lists by their ID and a specific field using the Trello Java SDK. This asynchronous operation includes callbacks for handling results and exceptions.
```java
String idList = "idList4";
String field = "field6";
String key = "key0";
String token = "token6";
listController.getListsByIdListByFieldAsync(idList, field, key, token).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Initialize SearchController
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/search.md
Initializes the SearchController using the Trello client. This is the starting point for performing search operations.
```java
SearchController searchController = client.getSearchController();
```
--------------------------------
### Get Organizations Members Cards Async
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/organization.md
Asynchronously retrieves cards for organization members. This Java example demonstrates how to call the `getOrganizationsMembersCardsByIdOrgByIdMemberAsync` method with various optional parameters and includes placeholders for success and failure callback handlers.
```Java
String idOrg = "idOrg0";
String idMember = "idMember6";
String key = "key0";
String token = "token6";
String attachmentFields = "all";
String memberFields = "avatarHash, fullName, initials and username";
String checklists = "none";
String boardFields = "name, desc, closed, idOrganization, pinned, url and prefs";
String listFields = "all";
String filter = "visible";
String fields = "all";
organizationController.getOrganizationsMembersCardsByIdOrgByIdMemberAsync(idOrg, idMember, key, token, null, null, attachmentFields, null, memberFields, null, checklists, null, boardFields, null, listFields, filter, fields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### TrelloClient Class API Documentation
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/client.md
Provides an overview of the TrelloClient class, its role as the SDK gateway, and lists its available controllers and methods for interacting with the Trello API.
```APIDOC
TrelloClient Class
The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
Controllers:
- getActionController(): Provides access to Action controller.
- getBatchController(): Provides access to Batch controller.
- getBoardController(): Provides access to Board controller.
- getCardController(): Provides access to Card controller.
- getChecklistController(): Provides access to Checklist controller.
- getLabelController(): Provides access to Label controller.
- getListController(): Provides access to List controller.
- getMemberController(): Provides access to Member controller.
- getNotificationController(): Provides access to Notification controller.
- getOrganizationController(): Provides access to Organization controller.
- getSearchController(): Provides access to Search controller.
- getSessionController(): Provides access to Session controller.
- getTokenController(): Provides access to Token controller.
- getTypeController(): Provides access to Type controller.
- getWebhookController(): Provides access to Webhook controller.
Methods:
- shutdown(): Shutdown the underlying HttpClient instance.
- getEnvironment(): Current API environment.
- getHttpClient(): The HTTP Client instance to use for making HTTP requests.
- getHttpClientConfig(): Http Client Configuration instance.
- getApiKeyCredentials(): The credentials to use with ApiKey.
- getApiTokenCredentials(): The credentials to use with ApiToken.
- getBaseUri(Server server): Get base URI by current environment
- getBaseUri(): Get base URI by current environment
```
--------------------------------
### Get Actions List by ID with Fields
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/action.md
Asynchronously retrieves a list of actions by their ID, allowing filtering by specific fields. Requires action ID, field, API key, and token. Includes example usage and error handling.
```APIDOC
CompletableFuture getActionsListByIdActionAsync(
final String idAction,
final String key,
final String token,
final String fields)
Parameters:
- idAction: String, Template, Required - idAction
- key: String, Query, Required - Generate your application key
- token: String, Query, Required - Getting a token from a user
- fields: String, Query, Optional - all or a comma-separated list of: closed, idBoard, name, pos or subscribed. Default: "all"
Response Type: void
Errors:
- 400: Server rejection - ApiException
```
--------------------------------
### Get Actions List by ID and Field
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/action.md
Asynchronously retrieves a list of actions by their ID and a specific field. Requires action ID, field, API key, and token. Includes example usage and error handling for a 400 status code.
```Java
String idAction = "idAction6";
String field = "field6";
String key = "key0";
String token = "token6";
actionController.getActionsListByIdActionByFieldAsync(idAction, field, key, token).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Trello SDK Action Update Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/action.md
Example of how to update an action using the Trello Java SDK, showing how to construct the Actions object and make the asynchronous update call.
```Java
String idAction = "idAction6";
String key = "key0";
String token = "token6";
Actions body = new Actions.Builder()
.build();
actionController.updateActionsByIdActionAsync(idAction, key, token, body).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Get Actions Entities by ID
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/action.md
Asynchronously retrieves action entities by their ID. This method requires the action ID, API key, and token. It returns a CompletableFuture and includes example usage and error handling for a 400 status code.
```APIDOC
CompletableFuture getActionsEntitiesByIdActionAsync(
final String idAction,
final String key,
final String token)
Parameters:
- idAction: String, Template, Required - idAction
- key: String, Query, Required - Generate your application key
- token: String, Query, Required - Getting a token from a user
Response Type: void
Errors:
- 400: Server rejection - ApiException
```
--------------------------------
### Get Boards by ID with various filters
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/board.md
Demonstrates how to retrieve Trello boards using the Java SDK, allowing for extensive filtering of associated data such as members, checklists, organizations, and custom fields. This example showcases asynchronous execution with success and failure callback handlers.
```java
String idBoard = "idBoard2";
String key = "key0";
String token = "token6";
String actionsFormat = "list";
String actionsLimit = "50";
String actionFields = "all";
String actionMemberFields = "avatarHash, fullName, initials and username";
String actionMemberCreatorFields = "avatarHash, fullName, initials and username";
String cards = "none";
String cardFields = "all";
String cardAttachmentFields = "all";
String cardChecklists = "none";
String boardStars = "none";
String labels = "none";
String labelFields = "all";
String labelsLimit = "50";
String lists = "none";
String listFields = "all";
String memberships = "none";
String membershipsMemberFields = "fullName and username";
String members = "none";
String memberFields = "avatarHash, initials, fullName, username and confirmed";
String membersInvited = "none";
String membersInvitedFields = "avatarHash, initials, fullName and username";
String checklists = "none";
String checklistFields = "all";
String organizationFields = "name and displayName";
String organizationMemberships = "none";
String fields = "name, desc, descData, closed, idOrganization, pinned, url, shortUrl, prefs and labelNames";
boardController.getBoardsByIdBoardAsync(idBoard, key, token, null, null, null, actionsFormat, null, actionsLimit, actionFields, null, actionMemberFields, null, actionMemberCreatorFields, cards, cardFields, null, cardAttachmentFields, cardChecklists, null, boardStars, labels, labelFields, labelsLimit, lists, listFields, memberships, null, membershipsMemberFields, members, memberFields, membersInvited, membersInvitedFields, checklists, checklistFields, null, organizationFields, organizationMemberships, null, fields).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Example Trello Card JSON
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/cards.md
Provides a sample JSON representation of a Trello card, illustrating how the fields are structured and populated.
```JSON
{
"closed": "closed4",
"desc": "desc0",
"due": "due6",
"fileSource": "fileSource8",
"idAttachmentCover": "idAttachmentCover0"
}
```
--------------------------------
### HttpClientConfiguration.Builder API
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/http-client-configuration-builder.md
API documentation for the HttpClientConfiguration.Builder class, covering its constructors and methods for configuring HTTP client settings such as timeouts, retries, and the OkHttpClient instance.
```APIDOC
HttpClientConfiguration.Builder:
Constructors:
Builder()
Default Constructor to initiate builder with default properties.
Methods:
timeout(long timeout): HttpClientConfiguration.Builder
Sets the timeout in seconds to use for making http requests.
numberOfRetries(int numberOfRetries): HttpClientConfiguration.Builder
Sets the number of retries to make.
backOffFactor(int backOffFactor): HttpClientConfiguration.Builder
Sets to use in calculation of wait time for next request in case of failure.
retryInterval(long retryInterval): HttpClientConfiguration.Builder
Sets to use in calculation of wait time for next request in case of failure.
httpStatusCodesToRetry(Set httpStatusCodesToRetry): HttpClientConfiguration.Builder
Sets http status codes to retry against.
httpMethodsToRetry(Set httpMethodsToRetry): HttpClientConfiguration.Builder
Sets http methods to retry against.
maximumRetryWaitTime(long maximumRetryWaitTime): HttpClientConfiguration.Builder
Sets the maximum wait time for overall retrying requests.
shouldRetryOnTimeout(boolean shouldRetryOnTimeout): HttpClientConfiguration.Builder
Sets whether to retry on request timeout.
httpClientInstance(okhttp3.OkHttpClient httpClientInstance): HttpClientConfiguration.Builder
Sets the okhttpclient instance used to make the http calls.
httpClientInstance(okhttp3.OkHttpClient httpClientInstance, boolean overrideHttpClientConfigurations): HttpClientConfiguration.Builder
Sets the okhttpclient instance used to make the http calls and an option to Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc.
build(): HttpClientConfiguration
Builds a new HttpClientConfiguration object using the set fields.
```
--------------------------------
### BoardsMemberships JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/boards-memberships.md
Provides an example of the BoardsMemberships structure represented in JSON format, showing the 'member_fields' and 'type' fields.
```JSON
{
"member_fields": "member_fields6",
"type": "type6"
}
```
--------------------------------
### Trello Java SDK Organization Boards Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/controllers/organization.md
Example Java code demonstrating how to fetch organization boards using the Trello Java SDK. It shows the asynchronous call to `getOrganizationsBoardsByIdOrgAsync` with various parameters and includes placeholders for success and failure callback handlers.
```Java
String idOrg = "idOrg0";
String key = "key0";
String token = "token6";
String filter = "all";
String fields = "all";
String actionsLimit = "50";
String actionsFormat = "list";
String actionFields = "all";
String memberships = "none";
String organizationFields = "name and displayName";
String lists = "none";
organizationController.getOrganizationsBoardsByIdOrgAsync(idOrg, key, token, filter, fields, null, null, actionsLimit, actionsFormat, null, actionFields, memberships, null, organizationFields, lists).thenAccept(result -> {
// TODO success callback handler
}).exceptionally(exception -> {
// TODO failure callback handler
exception.printStackTrace();
return null;
});
```
--------------------------------
### Organizations JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/organizations.md
An example of how the Organizations structure is represented in JSON format.
```JSON
{
"desc": "desc2",
"displayName": "displayName8",
"name": "name0",
"prefs/associatedDomain": "prefs/associatedDomain4",
"prefs/boardVisibilityRestrict/org": "prefs/boardVisibilityRestrict/org0"
}
```
--------------------------------
### Trello Java SDK CardsChecklists JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/cards-checklists.md
Provides a JSON representation of the CardsChecklists structure, showing example values for its fields.
```JSON
{
"idChecklistSource": "idChecklistSource4",
"name": "name6",
"value": "value8"
}
```
--------------------------------
### Trello Java SDK Actions JSON Example
Source: https://github.com/muhamza30/trello-java-sdk/blob/main/doc/models/actions.md
Provides an example of the Actions class represented in JSON format, showing the 'text' field with a sample value.
```JSON
{
"text": "text2"
}
```