Class Boards

Hierarchy

Boards

Constructors

constructor

new Boards(client): Boards
Parameters
- client: Client
Returns Boards
- Defined in api/boards.ts:7

Properties

`Private` client

client: Client

Methods

addMemberToBoard

addMemberToBoard<T>(parameters, callback): Promise<void>
Add a member to the board.
Type Parameters
- T = unknown
Parameters
- parameters: AddMemberToBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:416
addMemberToBoard<T>(parameters, callback?): Promise<T>
Add a member to the board.
Type Parameters
- T = unknown
Parameters
- parameters: AddMemberToBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:418

changeEmailList

changeEmailList<T>(parameters, callback): Promise<void>
Change the default list that email-to-board cards are created in.
Type Parameters
- T = unknown
Parameters
- parameters: ChangeEmailList
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:498
changeEmailList<T>(parameters, callback?): Promise<T>
Change the default list that email-to-board cards are created in.
Type Parameters
- T = unknown
Parameters
- parameters: ChangeEmailList
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:500

createBoard

createBoard<T>(parameters, callback): Promise<void>
Create a new board.
Type Parameters
- T = Board
Parameters
- parameters: CreateBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:623
createBoard<T>(parameters, callback?): Promise<T>
Create a new board.
Type Parameters
- T = Board
Parameters
- parameters: CreateBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:625

createBoardChecklist

createBoardChecklist<T>(parameters, callback): Promise<void>
Create a new checklist on a board.
Type Parameters
- T = unknown
Parameters
- parameters: CreateBoardChecklist
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:208
createBoardChecklist<T>(parameters, callback?): Promise<T>
Create a new checklist on a board.
Type Parameters
- T = unknown
Parameters
- parameters: CreateBoardChecklist
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:213

createBoardLabel

createBoardLabel<T>(parameters, callback): Promise<void>
Create a new Label on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: CreateBoardLabel
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:301
createBoardLabel<T>(parameters, callback?): Promise<T>
Create a new Label on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: CreateBoardLabel
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:303

createBoardList

createBoardList<T>(parameters, callback): Promise<void>
Create a new List on a Board.
Type Parameters
- T = List
Parameters
- parameters: CreateBoardList
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:343
createBoardList<T>(parameters, callback?): Promise<T>
Create a new List on a Board.
Type Parameters
- T = List
Parameters
- parameters: CreateBoardList
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:345

createCalendarKey

createCalendarKey<T>(parameters, callback): Promise<void>
Create a new board.
Type Parameters
- T = unknown
Parameters
- parameters: CreateCalendarKey
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:654
createCalendarKey<T>(parameters, callback?): Promise<T>
Create a new board.
Type Parameters
- T = unknown
Parameters
- parameters: CreateCalendarKey
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:656

createEmailKey

createEmailKey<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: CreateEmailKey
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:669
createEmailKey<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: CreateEmailKey
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:670

createIdTags

createIdTags<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: CreateIdTags
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:680
createIdTags<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: CreateIdTags
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:681

createPowerUp

createPowerUp<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: CreatePowerUp
- callback: Callback<T>
Returns Promise<void>

Deprecated
Was removed from API
- Defined in api/boards.ts:706
createPowerUp<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: CreatePowerUp
- Optional callback: undefined
Returns Promise<T>

Deprecated
Was removed from API
- Defined in api/boards.ts:708

deleteBoard

deleteBoard<T>(parameters, callback): Promise<void>
Delete a board.
Type Parameters
- T = void
Parameters
- parameters: DeleteBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:111
deleteBoard<T>(parameters, callback?): Promise<T>
Delete a board.
Type Parameters
- T = void
Parameters
- parameters: DeleteBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:113

deletePowerUp

deletePowerUp<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: DeletePowerUp
- callback: Callback<T>
Returns Promise<void>

Deprecated
Was removed from API
- Defined in api/boards.ts:722
deletePowerUp<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: DeletePowerUp
- Optional callback: undefined
Returns Promise<T>

Deprecated
Was removed from API
- Defined in api/boards.ts:724

disablePowerUp

disablePowerUp<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: DisablePowerUp
- callback: Callback<T>
Returns Promise<void>

Deprecated
Will be removed from API

Disable a Power-Up on a board
- Defined in api/boards.ts:789
disablePowerUp<T>(parameters, callback?): Promise<T>
Disable a Power-Up on a board
Type Parameters
- T = unknown
Parameters
- parameters: DisablePowerUp
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:791

enablePowerUp

enablePowerUp<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: EnablePowerUp
- callback: Callback<T>
Returns Promise<void>

Deprecated
Will be removed from API

Enable a Power-Up on a Board
- Defined in api/boards.ts:769
enablePowerUp<T>(parameters, callback?): Promise<T>
Enable a Power-Up on a Board
Type Parameters
- T = unknown
Parameters
- parameters: EnablePowerUp
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:771

getBoard

getBoard<T>(parameters, callback): Promise<void>
Request a single board.
Type Parameters
- T = Board
Parameters
- parameters: GetBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:39
getBoard<T>(parameters, callback?): Promise<T>
Request a single board.
Type Parameters
- T = Board
Parameters
- parameters: GetBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:41

getBoardActions

getBoardActions<T>(parameters, callback): Promise<void>
Get an Actions on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardActions
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:138
getBoardActions<T>(parameters, callback?): Promise<T>
Get an Actions on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardActions
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:140

getBoardCard

getBoardCard<T>(parameters, callback): Promise<void>
Get a single Card on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:157
getBoardCard<T>(parameters, callback?): Promise<T>
Get a single Card on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:159

getBoardCards

getBoardCards<T>(parameters, callback): Promise<void>
Get all of the open Cards on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardCards
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:230
getBoardCards<T>(parameters, callback?): Promise<T>
Get all of the open Cards on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardCards
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:232

getBoardCardsFilter

getBoardCardsFilter<T>(parameters, callback): Promise<void>
Get the Cards on a Board that match a given filter.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardCardsFilter
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:243
getBoardCardsFilter<T>(parameters, callback?): Promise<T>
Get the Cards on a Board that match a given filter.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardCardsFilter
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:248

getBoardChecklists

getBoardChecklists<T>(parameters, callback): Promise<void>
Get all of the checklists on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardChecklists
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:189
getBoardChecklists<T>(parameters, callback?): Promise<T>
Get all of the checklists on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardChecklists
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:194

getBoardCustomFields

getBoardCustomFields<T>(parameters, callback): Promise<void>
Get the Custom Field Definitions that exist on a board.
Type Parameters
- T = CustomField[]
Parameters
- parameters: GetBoardCustomFields
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:262
getBoardCustomFields<T>(parameters, callback?): Promise<T>
Get the Custom Field Definitions that exist on a board.
Type Parameters
- T = CustomField[]
Parameters
- parameters: GetBoardCustomFields
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:267

getBoardField

getBoardField<T>(parameters, callback): Promise<void>
Get a single, specific field on a board
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:125
getBoardField<T>(parameters, callback?): Promise<T>
Get a single, specific field on a board
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:127

getBoardLabels

getBoardLabels<T>(parameters, callback): Promise<void>
Get all of the Labels on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardLabels
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:284
getBoardLabels<T>(parameters, callback?): Promise<T>
Get all of the Labels on a Board.
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardLabels
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:286

getBoardLists

getBoardLists<T>(parameters, callback): Promise<void>
Get the Lists on a Board
Type Parameters
- T = List[]
Parameters
- parameters: GetBoardLists
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:321
getBoardLists<T>(parameters, callback?): Promise<T>
Get the Lists on a Board
Type Parameters
- T = List[]
Parameters
- parameters: GetBoardLists
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:323

getBoardListsFilter

getBoardListsFilter<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardListsFilter
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:362
getBoardListsFilter<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardListsFilter
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:366

getBoardMembers

getBoardMembers<T>(parameters, callback): Promise<void>
Get the Members for a board
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:380
getBoardMembers<T>(parameters, callback?): Promise<T>
Get the Members for a board
Type Parameters
- T = unknown
Parameters
- parameters: GetBoardMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:382

getBoardMemberships

getBoardMemberships<T>(parameters, callback): Promise<void>
Get information about the memberships users have to the board.
Type Parameters
- T = Memberships
Parameters
- parameters: GetBoardMemberships
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:10
getBoardMemberships<T>(parameters, callback?): Promise<T>
Get information about the memberships users have to the board.
Type Parameters
- T = Memberships
Parameters
- parameters: GetBoardMemberships
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:15

getBoardStars

getBoardStars<T>(parameters, callback): Promise<void>
Get a Stars on a Board.
Type Parameters
- T = BoardStars[]
Parameters
- parameters: GetBoardStars
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:170
getBoardStars<T>(parameters, callback?): Promise<T>
Get a Stars on a Board.
Type Parameters
- T = BoardStars[]
Parameters
- parameters: GetBoardStars
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:175

getEnabledPowerUps

getEnabledPowerUps<T>(parameters, callback): Promise<void>
Type Parameters
- T = Plugin[]
Parameters
- parameters: GetEnabledPowerUps
- callback: Callback<T>
Returns Promise<void>

Deprecated
Will be removed from API

Get the enabled Power-Ups on a board
- Defined in api/boards.ts:739
getEnabledPowerUps<T>(parameters, callback?): Promise<T>
Type Parameters
- T = Plugin[]
Parameters
- parameters: GetEnabledPowerUps
- Optional callback: undefined
Returns Promise<T>

Deprecated
Will be removed from API

Get the enabled Power-Ups on a board
- Defined in api/boards.ts:748

getPowerUps

getPowerUps<T>(parameters, callback): Promise<void>
Type Parameters
- T = Plugin
Parameters
- parameters: GetPowerUps
- callback: Callback<T>
Returns Promise<void>

Deprecated
Will be removed from API

List the Power-Ups on a board
- Defined in api/boards.ts:806
getPowerUps<T>(parameters, callback?): Promise<T>
Type Parameters
- T = Plugin
Parameters
- parameters: GetPowerUps
- Optional callback: undefined
Returns Promise<T>

Deprecated
Will be removed from API

List the Power-Ups on a board
- Defined in api/boards.ts:812

inviteMember

inviteMember<T>(parameters, callback): Promise<void>
Invite a Member to a Board via their email address.
Type Parameters
- T = unknown
Parameters
- parameters: InviteMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:396
inviteMember<T>(parameters, callback?): Promise<T>
Invite a Member to a Board via their email address.
Type Parameters
- T = unknown
Parameters
- parameters: InviteMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:398

markAsViewed

markAsViewed<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: MarkAsViewed
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:694
markAsViewed<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: MarkAsViewed
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:695

removeMemberFromBoard

removeMemberFromBoard<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: RemoveMemberFromBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:435
removeMemberFromBoard<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: RemoveMemberFromBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:439

updateBoard

updateBoard<T>(parameters, callback): Promise<void>
Update an existing board by id
Type Parameters
- T = unknown
Parameters
- parameters: UpdateBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:75
updateBoard<T>(parameters, callback?): Promise<T>
Update an existing board by id
Type Parameters
- T = unknown
Parameters
- parameters: UpdateBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:77

updateEmailPosition

updateEmailPosition<T>(parameters, callback): Promise<void>
Update emailPosition Pref on a Board
Type Parameters
- T = unknown
Parameters
- parameters: UpdateEmailPosition
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:476
updateEmailPosition<T>(parameters, callback?): Promise<T>
Update emailPosition Pref on a Board
Type Parameters
- T = unknown
Parameters
- parameters: UpdateEmailPosition
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:481

updateMemberOnBoard

updateMemberOnBoard<T>(parameters, callback): Promise<void>
Update an existing board by id
Type Parameters
- T = unknown
Parameters
- parameters: UpdateMemberOnBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:453
updateMemberOnBoard<T>(parameters, callback?): Promise<T>
Update an existing board by id
Type Parameters
- T = unknown
Parameters
- parameters: UpdateMemberOnBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:458

updateShowListGuide

updateShowListGuide<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowListGuide
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:516
updateShowListGuide<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowListGuide
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:520

updateShowSidebar

updateShowSidebar<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebar
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:536
updateShowSidebar<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebar
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:537

updateShowSidebarActivity

updateShowSidebarActivity<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebarActivity
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:553
updateShowSidebarActivity<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebarActivity
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:557

updateShowSidebarBoardActions

updateShowSidebarBoardActions<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebarBoardActions
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:576
updateShowSidebarBoardActions<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebarBoardActions
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:580

updateShowSidebarMembers

updateShowSidebarMembers<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebarMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in api/boards.ts:599
updateShowSidebarMembers<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: UpdateShowSidebarMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in api/boards.ts:603

Class Boards

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Boards

Properties

Private client

Methods

addMemberToBoard

Type Parameters

T = unknown

Parameters

parameters: AddMemberToBoard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: AddMemberToBoard

Optional callback: undefined

Returns Promise<T>

changeEmailList

Type Parameters

T = unknown

Parameters

parameters: ChangeEmailList

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: ChangeEmailList

Optional callback: undefined

Returns Promise<T>

createBoard

Type Parameters

T = Board

Parameters

parameters: CreateBoard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Board

Parameters

parameters: CreateBoard

Optional callback: undefined

Returns Promise<T>

createBoardChecklist

Type Parameters

T = unknown

Parameters

parameters: CreateBoardChecklist

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: CreateBoardChecklist

Optional callback: undefined

Returns Promise<T>

createBoardLabel

Type Parameters

T = unknown

Parameters

parameters: CreateBoardLabel

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: CreateBoardLabel

Optional callback: undefined

Returns Promise<T>

createBoardList

`Private` client

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined