Class: AllFlowsPrecondition
Hierarchy
↳
AllFlowsPrecondition
Constructors
constructor
• new AllFlowsPrecondition(context
, options?
)
Parameters
Name | Type |
---|---|
context | PieceContext |
options | PreconditionOptions |
Inherited from
Defined in
projects/framework/src/lib/structures/Precondition.ts:23
Properties
enabled
• enabled: boolean
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:450
location
• Readonly
location: PieceLocation
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:442
name
• Readonly
name: string
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:446
options
• Readonly
options: PreconditionOptions
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:454
position
• Readonly
position: null
| number
Inherited from
Defined in
projects/framework/src/lib/structures/Precondition.ts:21
store
• Readonly
store: Store
<Piece
<PieceOptions
>>
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:438
Accessors
container
• get
container(): Container
Returns
Container
Inherited from
Precondition.container
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:460
Methods
chatInputRun
▸ Abstract
chatInputRun(interaction
, command
, context
): PreconditionResult
Parameters
Name | Type |
---|---|
interaction | ChatInputCommandInteraction <CacheType > |
command | ChatInputCommand |
context | PreconditionContext |
Returns
Overrides
Defined in
projects/framework/src/lib/structures/Precondition.ts:63
contextMenuRun
▸ Abstract
contextMenuRun(interaction
, command
, context
): PreconditionResult
Parameters
Name | Type |
---|---|
interaction | ContextMenuCommandInteraction <CacheType > |
command | ContextMenuCommand |
context | PreconditionContext |
Returns
Overrides
Defined in
projects/framework/src/lib/structures/Precondition.ts:69
error
▸ error(options?
): PreconditionResult
Parameters
Name | Type | Description |
---|---|---|
options | Omit <Options , "precondition" > |
Returns
Inherited from
Defined in
projects/framework/src/lib/structures/Precondition.ts:46
fetchChannelFromInteraction
▸ Protected
fetchChannelFromInteraction(interaction
): Promise
<TextBasedChannel
>
Parameters
Name | Type |
---|---|
interaction | CommandInteraction <CacheType > |
Returns
Promise
<TextBasedChannel
>
Inherited from
Precondition.fetchChannelFromInteraction
Defined in
projects/framework/src/lib/structures/Precondition.ts:50
messageRun
▸ Abstract
messageRun(message
, command
, context
): PreconditionResult
Parameters
Name | Type |
---|---|
message | Message <boolean > |
command | MessageCommand |
context | PreconditionContext |
Returns
Overrides
Defined in
projects/framework/src/lib/structures/Precondition.ts:61
ok
▸ ok(): PreconditionResult
Returns
Inherited from
Defined in
projects/framework/src/lib/structures/Precondition.ts:38
onLoad
▸ onLoad(): unknown
Returns
unknown
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:465
onUnload
▸ onUnload(): unknown
Returns
unknown
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:470
reload
▸ reload(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:478
toJSON
▸ toJSON(): PieceJSON
Returns
PieceJSON
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:482
unload
▸ unload(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:474