Carbon
Plugins/Linked Roles/Type Aliases

LinkedRolesOptions

LinkedRolesOptions = object

The options for the linked roles package

Properties

disableDeployRoute?

optional disableDeployRoute: boolean

Whether the deploy route should be disabled.

Default

false

disableVerifyUserCallbackRoute?

optional disableVerifyUserCallbackRoute: boolean

Whether the connect callback route should be disabled.

Default

false

disableVerifyUserRoute?

optional disableVerifyUserRoute: boolean

Whether the connect route should be disabled.

Default

false

metadata

metadata: LinkedRoleCriteria[]

The metadata that you want to check for, and that should show to the end-user on Discord.


metadataCheckers

metadataCheckers: object

The functions that you want to use to check the metadata.

Index Signature

[name: string]: (userId) => Promise<number | boolean>

Remarks

If you are checking a boolean, you should return true or false. If you are checking an integer, you should return a number that is safe to use as an integer. If you are checking a datetime, you should return a Date.now() timestamp.

On this page