Skip to content
popii
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Configuration
Discord application setup
Build your first bot
Installation
Introducing Cakemix
Project structure
Core Concepts
Commands and options
Events
Lifecycle, context, and sharding
Localization and errors
Middleware
Core concepts
Cakemix presentation
Snaps and tasks
CLI
CLI
Dashboard
Accessibility and responsive behavior
Cakemix branding
Community tools
Guided configuration
Music workspace
Owner operations
Cakemix dashboard
Cakemix feature parity
Dashboard security
Dashboard setup
Server workspaces
Plugins
Built-in plugins
Create a plugin
Dashboard contributions
Testing
Testing
Production Operations
Production operations
Upgrading to 1.0
Upgrade to Popii 1.0 — Cakemix
Reference
api
Popii 1.0 — Cakemix
classes
ApplicationLifecycle
AuthorizationError
CancelledError
CanvasBuilder
ClientStateService
ConfigurationError
ConflictError
CooldownError
DefinitionRegistry
DiscordError
EventDispatcher
FrameworkError
LocalizationService
MemoryMetrics
MemoryShardTransport
MemoryStore
PersistenceError
PluginError
PluginRuntime
PopiiError
PopiiShardingManager
PopiiSilentError
QuotaError
TaskRunner
TimeoutError
ValidationError
functions
activityRotatorPlugin()
auditLogPlugin()
autoModPlugin()
autoRolePlugin()
autoShard()
buildRssEmbed()
builtInPlugin()
cakemixEmbed()
cakemixError()
canvasPlugin()
captchaPlugin()
command()
commandAnalyticPlugin()
commandLoggerPlugin()
createApplication()
createExecutionContext()
createJsonLogger()
defineConfig()
defineDashboardContribution()
defineDashboardContributionV2()
deskPlugin()
economyPlugin()
ensureSnapshotsModel()
ensureSnapshotsTable()
errorHandlerPlugin()
event()
execute()
flattenLocale()
freezeMap()
gamesPlugin()
gdprPlugin()
getBuiltInOptionsSchema()
getBuiltInPluginManifest()
giveawayPlugin()
governPlugin()
lastFmPlugin()
levelsPlugin()
middleware()
moderationPlugin()
mongoosePlugin()
normalizeError()
notifyPlugin()
packCustomId()
parseFeed()
parsePopiiConfig()
payPlugin()
permissionGuardPlugin()
pluginSetupPath()
pollPlugin()
popiiAiPlugin()
popiiClient()
reactionRolesPlugin()
redact()
remindersPlugin()
removeAllOptions()
removeOption()
renameOption()
replaceOptionValue()
requestShard()
resolveBuiltInPlugins()
rssPlugin()
snap()
snapshotsPlugin()
sqlitePlugin()
starboardPlugin()
suggestionsPlugin()
synchronizeCommands()
task()
telemetryPlugin()
uiPlugin()
unpackCustomId()
voicePlugin()
webhookPlugin()
webPlugin()
welcomePlugin()
withAuditContext()
Popii
interfaces
ActivityRotatorOptions
AuditAdapter
AuditContext
AuditLogEntry
AutoModOptions
AutoRolePluginOptions
BuiltInPluginInitDefinition
CanvasPluginOptions
CaptchaPluginOptions
Clock
CommandLoggerOptions
CommandSyncOptions
ComponentPop
CustomIdPayload
DashboardAction
DashboardActionContext
DashboardActionDefinition
DashboardActionFormField
DashboardActionResult
DashboardAuditDescriptor
DashboardChartData
DashboardCompositeData
DashboardContext
DashboardContribution
DashboardContributionV2
DashboardDetailData
DashboardEntityValue
DashboardExperience
DashboardField
DashboardFormData
DashboardNavigationDefinition
DashboardPage
DashboardPageBase
DashboardPageDefinition
DashboardRelatedDestination
DashboardSection
DashboardSummaryData
DashboardTableData
DashboardTimelineData
DefinitionMetadata
Disposable
EconomyPluginOptions
ErrorHandlerPluginOptions
EventPop
ExecutionContext
ExecutionHooks
ExecutionInfo
FeedItem
FormField
GamesPluginOptions
GdprPluginOptions
GiveawayPluginOptions
KeyValueStore
LevelsPluginOptions
LifecycleOptions
Metrics
ModerationPluginOptions
MongoosePluginOptions
NotifyPluginOptions
NowPlayingCardOptions
NowPlayingTrack
PluginDeclaration
PluginEnvironmentRequirement
PluginManifest
PluginSetupContext
PluginSetupDefinition
PollPluginOptions
Pop
PopiiAiOptions
PopiiApplication
PopiiAutoShardOptions
PopiiClient
PopiiClientConfig
PopiiCommandDefinition
PopiiComponentDefinition
PopiiDeskOptions
PopiiLastFmOptions
PopiiLocals
PopiiMigration
PopiiOption
PopiiPayOptions
PopiiPlugin
PopiiPluginConfigField
PopiiPluginMeta
PopiiRedisClient
PopiiSchema
PopiiServerSetting
PopiiShardingOptions
PopiiStorageAdapter
PopiiTaskDefinition
PopLogger
PopOptions
RetryPolicy
RuntimeEvent
RuntimePlugin
SettingsBackup
SetupPreset
SetupStep
ShardTransport
SnapshotsPluginOptions
SQLitePluginOptions
StarboardPluginOptions
StructuredLogger
TaskDefinition
TaskOutcome
TaskPop
TelemetryPluginOptions
UIPluginOptions
VoicePluginOptions
WebBrandingOptions
WebhookEndpoint
WebhookEndpointMeta
WebhookPluginOptions
WebPluginOptions
WelcomePluginOptions
WizardStep
type-aliases
AccessLevel
ApiFailure
ApiSuccess
ApplicationState
BroadcastEnvelope
CakemixTone
ComponentErrorMiddleware
ComponentMiddleware
ComponentRegularMiddleware
DashboardAudience
DashboardCapability
DashboardIcon
DashboardLayoutKind
DashboardPageData
DashboardRateLimitClass
DashboardValue
ErrorVisibility
LocaleDictionary
Next
OverlapPolicy
PluginInitCategory
PluginStability
PluginStarterPack
PopiiConfig
PopiiErrorMiddleware
PopiiEventFunction
PopiiMiddleware
PopiiRegularMiddleware
RuntimeMiddleware
SbSegment
ShardEnvelope
ShutdownReason
variables
broadcastEnvelopeSchema
builtInOptionsSchemas
builtInPluginCatalog
builtInPluginManifests
CAKEMIX\_COLORS
migrations
pluginStarterPacks
POPII\_RELEASE
popiiConfigSchema
popiiEnvironmentSchema
shardEnvelopeSchema
systemClock
webEnvironmentSchema
Configuration reference
Environment variables
Generated reference
Contributing
Architecture
GitHub
Select theme
Dark
Light
Auto
WelcomePluginOptions
Popii
Popii
/ WelcomePluginOptions
Interface: WelcomePluginOptions
Section titled “Interface: WelcomePluginOptions”
Defined in:
plugins/welcome.ts:8