LinkedRoles

This class is the main class that is used for the linked roles feature of Carbon. It handles all the additional routes and oauth.

Example

import { Client, ApplicationRoleConnectionMetadataType } from "@buape/carbon"
import { LinkedRoles } from "@buape/carbon/linked-roles"
 
const linkedRoles = new LinkedRoles({
  metadata: [
	   {
		   key: "is_staff",
		   name: "Verified Staff",
		   description: "Whether the user is a verified staff member",
		   type: ApplicationRoleConnectionMetadataType.BooleanEqual
	   }
  ],
  metadataCheckers: {
    is_staff: async (userId) => {
      const allStaff = ["439223656200273932"]
      return allStaff.includes(userId)
    }
  }
})
 
const client = new Client({ ...  }, [ ... ], [linkedRoles])

Extends

Plugin

Constructors

Constructor

new LinkedRoles(options): LinkedRoles

Parameters

Parameter	Type
`options`	`LinkedRolesOptions`

Returns

LinkedRoles

Overrides

Plugin.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides
`client?`	`public`	`Client`	`undefined`	-	-
`id`	`readonly`	`"linked-roles"`	`"linked-roles"`	An ID that identifies the plugin uniquely between all other used plugins in the Client	`Plugin`.`id`
`options`	`public`	`LinkedRolesOptions`	`undefined`	-	-