Class REST/Interactions

Various methods for interacting with interactions. Located at Client#rest .interactions.

Hierarchy

REST/Interactions

Index

Constructors

Methods

createFollowupMessage createInteractionResponse deleteFollowupMessage deleteOriginalMessage editFollowupMessage editOriginalMessage getFollowupMessage getOriginalMessage

Constructors

constructor

new Interactions(manager): REST/Interactions
Parameters
- manager: RESTManager
Returns REST/Interactions
- Defined in lib/routes/Interactions.ts:14

Methods

createFollowupMessage

createFollowupMessage<T>(applicationID, interactionToken, options): Promise<Message<T>>
Create a followup message.
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
- options: InteractionContent
  
  The options for creating the followup message.
Returns Promise<Message<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:25

createInteractionResponse

createInteractionResponse(interactionID, interactionToken, options): Promise<void>
Create an initial interaction response.
Parameters
- interactionID: string
  
  The ID of the interaction.
- interactionToken: string
  
  The token of the interaction.
- options: InteractionResponse
  
  The options for creating the interaction response.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:36

deleteFollowupMessage

deleteFollowupMessage(applicationID, interactionToken, messageID): Promise<void>
Delete a follow-up message.
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
- messageID: string
  
  The ID of the message.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:98

deleteOriginalMessage

deleteOriginalMessage(applicationID, interactionToken): Promise<void>
Delete the original interaction response.
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:108

editFollowupMessage

editFollowupMessage<T>(applicationID, interactionToken, messageID, options): Promise<Message<T>>
Edit a followup message.
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
- messageID: string
  
  The ID of the message.
- options: InteractionContent
  
  The options for editing the followup message.
Returns Promise<Message<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:120

editOriginalMessage

editOriginalMessage<T>(applicationID, interactionToken, options): Promise<Message<T>>
Edit an original interaction response.
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
- options: InteractionContent
  
  The options for editing the original message.
Returns Promise<Message<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:131

getFollowupMessage

getFollowupMessage<T>(applicationID, interactionToken, messageID): Promise<Message<T>>
Get a followup message.
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
- messageID: string
  
  The ID of the message.
Returns Promise<Message<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:142

getOriginalMessage

getOriginalMessage<T>(applicationID, interactionToken): Promise<Message<T>>
Get an original interaction response.
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- applicationID: string
  
  The ID of the application.
- interactionToken: string
  
  The token of the interaction.
Returns Promise<Message<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/Interactions.ts:152

Class REST/Interactions

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns REST/Interactions

Methods

createFollowupMessage

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

applicationID: string

interactionToken: string

options: InteractionContent

Returns Promise<Message<T>>

Caching

createInteractionResponse

Parameters

interactionID: string

interactionToken: string

options: InteractionResponse

Returns Promise<void>

Caching

deleteFollowupMessage

Parameters

applicationID: string

interactionToken: string

messageID: string

Returns Promise<void>

Caching

deleteOriginalMessage

Parameters

applicationID: string

interactionToken: string

Returns Promise<void>

Caching

editFollowupMessage

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

applicationID: string

interactionToken: string

messageID: string

options: InteractionContent

Returns Promise<Message<T>>

Caching

editOriginalMessage

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

applicationID: string

interactionToken: string

options: InteractionContent

Returns Promise<Message<T>>

Caching

getFollowupMessage

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

applicationID: string

interactionToken: string

messageID: string

Returns Promise<Message<T>>

Caching

getOriginalMessage

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

applicationID: string

interactionToken: string

Returns Promise<Message<T>>

Caching

On This Page