Class ContextPreconditionAbstract

Hierarchy

  • Precondition
    • ContextPrecondition

Constructors

constructor

Properties

enabled location name options position store

Accessors

container

Methods

chatInputRun contextMenuRun contextRun error fetchChannelFromInteraction messageRun ok onLoad onUnload reload toJSON unload

Constructors

constructor

  • new ContextPrecondition(context, options?): ContextPrecondition

  • Parameters

    • context: LoaderContext
    • Optionaloptions: PreconditionOptions

    Returns ContextPrecondition

Properties

enabled

enabled: boolean

Whether or not the piece is enabled.

Readonlylocation

location: PieceLocation

The location metadata for the piece's file.

Readonlyname

name: string

The name of the piece.

Readonlyoptions

options: PreconditionOptions

The raw options passed to this Piece

Readonlyposition

position: null | number

Readonlystore

store: PreconditionStore

The store that contains the piece.

Accessors

container

  • get container(): Container

  • A reference to the Container object for ease of use.

    Returns Container

    See

    container

Methods

chatInputRun

contextMenuRun

AbstractcontextRun

error

  • error(options?): PreconditionResult

  • Constructs a PreconditionError with the precondition parameter set to this.

    Parameters

    • Optionaloptions: Omit<Options, "precondition">

      The information.

    Returns PreconditionResult

ProtectedfetchChannelFromInteraction

messageRun

ok

  • ok(): PreconditionResult

  • Returns PreconditionResult

onLoad

  • onLoad(): unknown

  • Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

    Returns unknown

onUnload

  • onUnload(): unknown

  • Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

    Returns unknown

reload

  • reload(): Promise<void>

  • Reloads the piece by loading the same path in the store.

    Returns Promise<void>

toJSON

  • toJSON(): PieceJSON

  • Defines the JSON.stringify behavior of this piece.

    Returns PieceJSON

unload

  • unload(): Promise<void>

  • Unloads and disables the piece.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods