Skip to content
Discord Luau

Action

Implementation of a discord automod action object as a luau builder.

Summary

Properties

Action.type :: apiTypes.ActionTypesAction.metadata :: Builders.AutoModeration.ActionMetadata

Methods

Action:setType(type: apiTypes.ActionTypes) → ActionAction:setMetadata(metadata: metadata.JSON) → ActionAction:build() → JSON

Functions

Action.new(resource: { type: apiTypes.ActionTypes?, metadata: metadata.JSON?, }?) → Action

Properties

Section titled “Properties”

type

Section titled “type”
Action.type  :: ActionTypes

The type of action to perform when a rule is triggered.

metadata

Section titled “metadata”
Action.metadata  :: ActionMetadata

Additional metadata needed during execution for this specific action type.

Methods

Section titled “Methods”

setType

Section titled “setType”
Action : setType ( type )  -> Action

Sets the type of the action.

Parameters

type: ActionTypes

Returns

Action

setMetadata

Section titled “setMetadata”
Action : setMetadata ( metadata )  -> Action

Sets the action metadata.

Parameters

metadata: JSON

Returns

Action

build

Section titled “build”
Action : build ( )  -> JSON

Builds the action object.

Returns

JSON

Functions

Section titled “Functions”

new

Section titled “new”
Action . new ( resource )  -> Action

Responsible for creating a new Action.

Parameters

resource: {
type: apiTypes.ActionTypes?,
metadata: metadata.JSON?,
}

Returns

Action