Class Actions

Hierarchy

Actions

Index

Constructors

Properties

Methods

addActionReaction deleteAction deleteActionReaction getAction getActionBoard getActionCard getActionField getActionList getActionMember getActionMemberCreator getActionOrganization getActionReaction getActionReactionSummary getActionReactions updateAction updateActionText

Constructors

constructor

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

Properties

`Private` client

client: Client

Methods

addActionReaction

addActionReaction<T>(parameters, callback): Promise<void>
Adds a new reaction to an action
Type Parameters
- T = unknown
Parameters
- parameters: AddActionReaction
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:248
addActionReaction<T>(parameters, callback?): Promise<T>
Adds a new reaction to an action
Type Parameters
- T = unknown
Parameters
- parameters: AddActionReaction
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:250

deleteAction

deleteAction<T>(parameters, callback): Promise<void>
Delete a specific action. Only comment actions can be deleted.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteAction
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:48
deleteAction<T>(parameters, callback?): Promise<T>
Delete a specific action. Only comment actions can be deleted.
Type Parameters
- T = unknown
Parameters
- parameters: DeleteAction
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:50

deleteActionReaction

deleteActionReaction<T>(parameters, callback): Promise<void>
Deletes a reaction
Type Parameters
- T = unknown
Parameters
- parameters: DeleteActionReaction
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:290
deleteActionReaction<T>(parameters, callback?): Promise<T>
Deletes a reaction
Type Parameters
- T = unknown
Parameters
- parameters: DeleteActionReaction
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:295

getAction

getAction<T>(parameters, callback): Promise<void>
Get an Action
Type Parameters
- T = Action
Parameters
- parameters: GetAction
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:10
getAction<T>(parameters, callback?): Promise<T>
Get an Action
Type Parameters
- T = Action
Parameters
- parameters: GetAction
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:12

getActionBoard

getActionBoard<T>(parameters, callback): Promise<void>
Get the Board for an Action
Type Parameters
- T = Board
Parameters
- parameters: GetActionBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:77
getActionBoard<T>(parameters, callback?): Promise<T>
Get the Board for an Action
Type Parameters
- T = Board
Parameters
- parameters: GetActionBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:79

getActionCard

getActionCard<T>(parameters, callback): Promise<void>
Get the card for an action
Type Parameters
- T = Card
Parameters
- parameters: GetActionCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:96
getActionCard<T>(parameters, callback?): Promise<T>
Get the card for an action
Type Parameters
- T = Card
Parameters
- parameters: GetActionCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:98

getActionField

getActionField<T>(parameters, callback): Promise<void>
Get a specific property of an action
Type Parameters
- T = Action
Parameters
- parameters: GetActionField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:61
getActionField<T>(parameters, callback?): Promise<T>
Get a specific property of an action
Type Parameters
- T = Action
Parameters
- parameters: GetActionField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:63

getActionList

getActionList<T>(parameters, callback): Promise<void>
Get the List for an Action
Type Parameters
- T = List
Parameters
- parameters: GetActionList
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:115
getActionList<T>(parameters, callback?): Promise<T>
Get the List for an Action
Type Parameters
- T = List
Parameters
- parameters: GetActionList
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:117

getActionMember

getActionMember<T>(parameters, callback): Promise<void>
Gets the member of an action (not the creator)
Type Parameters
- T = Member
Parameters
- parameters: GetActionMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:134
getActionMember<T>(parameters, callback?): Promise<T>
Gets the member of an action (not the creator)
Type Parameters
- T = Member
Parameters
- parameters: GetActionMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:139

getActionMemberCreator

getActionMemberCreator<T>(parameters, callback): Promise<void>
Get the Member who created the Action
Type Parameters
- T = Member
Parameters
- parameters: GetActionMemberCreator
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:156
getActionMemberCreator<T>(parameters, callback?): Promise<T>
Get the Member who created the Action
Type Parameters
- T = Member
Parameters
- parameters: GetActionMemberCreator
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:161

getActionOrganization

getActionOrganization<T>(parameters, callback): Promise<void>
Get the Organization of an Action
Type Parameters
- T = Organization
Parameters
- parameters: GetActionOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:181
getActionOrganization<T>(parameters, callback?): Promise<T>
Get the Organization of an Action
Type Parameters
- T = Organization
Parameters
- parameters: GetActionOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:186

getActionReaction

getActionReaction<T>(parameters, callback): Promise<void>
Get information for a reaction
Type Parameters
- T = unknown
Parameters
- parameters: GetActionReaction
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:270
getActionReaction<T>(parameters, callback?): Promise<T>
Get information for a reaction
Type Parameters
- T = unknown
Parameters
- parameters: GetActionReaction
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:272

getActionReactionSummary

getActionReactionSummary<T>(parameters, callback): Promise<void>
List a summary of all reactions for an action
Type Parameters
- T = unknown
Parameters
- parameters: GetActionReactionSummary
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:309
getActionReactionSummary<T>(parameters, callback?): Promise<T>
List a summary of all reactions for an action
Type Parameters
- T = unknown
Parameters
- parameters: GetActionReactionSummary
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:314

getActionReactions

getActionReactions<T>(parameters, callback): Promise<void>
List reactions for an action
Type Parameters
- T = unknown
Parameters
- parameters: GetActionReactions
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:225
getActionReactions<T>(parameters, callback?): Promise<T>
List reactions for an action
Type Parameters
- T = unknown
Parameters
- parameters: GetActionReactions
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:230

updateAction

updateAction<T>(parameters, callback): Promise<void>
Update a specific Action. Only comment actions can be updated. Used to edit the content of a comment.
Type Parameters
- T = unknown
Parameters
- parameters: UpdateAction
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:32
updateAction<T>(parameters, callback?): Promise<T>
Update a specific Action. Only comment actions can be updated. Used to edit the content of a comment.
Type Parameters
- T = unknown
Parameters
- parameters: UpdateAction
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:34

updateActionText

updateActionText<T>(parameters, callback): Promise<void>
Update a comment action
Type Parameters
- T = unknown
Parameters
- parameters: UpdateActionText
- callback: Callback<T>
Returns Promise<void>
- Defined in api/actions.ts:206
updateActionText<T>(parameters, callback?): Promise<T>
Update a comment action
Type Parameters
- T = unknown
Parameters
- parameters: UpdateActionText
- Optional callback: undefined
Returns Promise<T>
- Defined in api/actions.ts:208

Class Actions

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Actions

Properties

Private client

Methods

addActionReaction

Type Parameters

T = unknown

Parameters

parameters: AddActionReaction

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: AddActionReaction

Optional callback: undefined

Returns Promise<T>

deleteAction

Type Parameters

T = unknown

Parameters

parameters: DeleteAction

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteAction

Optional callback: undefined

Returns Promise<T>

deleteActionReaction

Type Parameters

T = unknown

Parameters

parameters: DeleteActionReaction

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: DeleteActionReaction

Optional callback: undefined

Returns Promise<T>

getAction

Type Parameters

T = Action

Parameters

parameters: GetAction

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Action

Parameters

parameters: GetAction

Optional callback: undefined

Returns Promise<T>

getActionBoard

Type Parameters

T = Board

Parameters

parameters: GetActionBoard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = Board

Parameters

parameters: GetActionBoard

Optional callback: undefined

Returns Promise<T>

getActionCard

`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