-
-
Notifications
You must be signed in to change notification settings - Fork 5
TrelloClient
Rasmus Wulff Jensen edited this page May 12, 2023
·
64 revisions
This is the Main Client to communicate with the Trello API (aka everything is done via this)
In order to instantiate the client you need to provide:
| Option | Description |
|---|---|
ApiKey (Required) |
The Trello API Key you get on https://trello.com/power-ups/admin/ |
Token (Required) |
Your Authorization Token you generate get on https://trello.com/power-ups/admin/ |
Options (Optional) |
Various options for the client (if null default options will be used) See below for details |
HttpClient (Optional) |
Optional HTTP Client if you wish to specify it on your own (else an internal static HttpClient will be used for re-use) |
Example
TrelloClient client = new TrelloClient("APIKey", "TOKEN");The TrelloClientOptions can be passed optionally to the TrelloClient Constructor with the following options:
| Option | Description |
|---|---|
ApiCallExceptionOption |
Control level of URL Details are shown in Exceptions from calls to the API |
AllowDeleteOfBoards |
Controls if it is allowed to delete Boards (secondary confirmation) |
IncludeCustomFieldsInCardGetMethods |
Control if cards should retrieve Custom Fields when retrieving cards (WARNING: Non-Get-Methods returning Card will NOT include Custom fields) |
IncludeAttachmentsInCardGetMethods |
Control if cards should retrieve Attachments when retrieving cards (WARNING: Non-Get-Methods returning Card will NOT include Attachments) |
AllowDeleteOfOrganizations |
Controls if it is allowed to delete Organizations (secondary confirmation) |
| Feature | Description |
|---|---|
| GetActionsOfBoardAsync | Get the most recent Actions (Changelog Events) of a board |
| GetActionsOnCardAsync | Get the most recent Actions (Changelog Events) on a Card |
| GetActionsForListAsync | Get the most recent Actions (Changelog Events) for a List |
| GetActionsForMemberAsync | Get the most recent Actions (Changelog Events) for a Member |
| GetActionsForOrganizationsAsync | Get the most recent Actions (Changelog Events) for an Organization |
| Feature | Description |
|---|---|
| GetAttachmentsOnCardAsync | Get Attachments on a card |
| DeleteAttachmentOnCardAsync | Delete an Attachments on a card |
| AddAttachmentToCardAsync | Add an Attachment to a Card |
| Feature | Description |
|---|---|
| AddBoardAsync | Add a new Board |
| CloseBoardAsync | Close (Archive) a Board |
| ReOpenBoardAsync | ReOpen a Board |
| UpdateBoardAsync | Update a Board |
| DeleteBoardAsync | Delete an entire board (WARNING: THERE IS NO WAY GOING BACK!!!). Alternative use CloseBoard() for non-permanency |
| GetBoardAsync | Get a Board by its Id |
| GetBoardsForMemberAsync | Get the Boards that the specified member has access to |
| GetBoardsCurrentTokenCanAccessAsync | Get the Boards that the token provided to the TrelloClient can Access |
| GetBoardsInOrganization | Get the Boards in an Organization |
| Feature | Description |
|---|---|
| AddCardAsync | Add a Card |
| ArchiveCardAsync | Archive (Close) a Card |
| ReOpenCardAsync | ReOpen (Send back to board) a Card |
| UpdateCardAsync | Update a Card |
| ArchiveAllCardsInListAsync | Archive all cards on in a List |
| MoveAllCardsInListAsync | Move all cards of a list to another list |
| DeleteCardAsync | Delete a Card (WARNING: THERE IS NO WAY GOING BACK!!!). Alternative use CloseCard() for non-permanency |
| GetCardAsync | Get Card by its Id |
| GetCardsOnBoardAsync | Get all open cards on un-archived lists |
| GetCardsInListAsync | Get all open cards on a specific list |
| GetCardsOnBoardFilteredAsync | Get the cards on board based on their status regardless if they are on archived lists |
| GetCardsForMemberAsync | Get all Cards a Member is on (across multiple boards) |
| SetDueDateOnCardAsync | Set Due Date on a card |
| SetStartDateOnCardAsync | Set Due Date on a card |
| SetStartDateAndDueDateOnCardAsync | Set Start and Due Date on a card |
| Feature | Description |
|---|---|
| AddChecklistAsync | Add a Checklist to the card |
| AddChecklistAsync | Add a Checklist to the card based on an existing checklist (as a copy) |
| UpdateChecklistItemAsync | Update a Check-item on a Card |
| GetChecklistAsync | Get a Checklist with a specific Id |
| GetChecklistsOnBoardAsync | Get a list of Checklists that are used on cards on a specific Board |
| GetChecklistsOnCardAsync | Get a list of Checklists that are used on a specific card |
| DeleteChecklistAsync | Delete a Checklist (WARNING: THERE IS NO WAY GOING BACK!!!) |
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
| Feature | Description |
|---|---|
If you are looking for info on a specific method in TrelloDotNet then expand the Pages above and input the 'MethodName' (Example: 'AddCardAsync')