Skip to main content

Interface: CreateModeratorInviteOptions

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / CreateModeratorInviteOptions

Interface: CreateModeratorInviteOptions

Defined in: packages/launchpad-sdk/dist/types/moderator.dto.d.ts:110

Options for creating a new moderator invite.

Example​

// Create TOKEN scope invite (access to specific token)
const tokenInvite: CreateModeratorInviteOptions = {
  tokenName: 'mytoken',
  role: 'MODERATOR',
  description: 'John - Friday evening shows',
  expiresAt: '2025-12-31T23:59:59Z'
};

// Create ALL_OWNER_TOKENS scope invite (blanket access)
const blanketInvite: CreateModeratorInviteOptions = {
  inviteScope: 'ALL_OWNER_TOKENS',
  role: 'MANAGER',
  description: 'Studio team - all tokens'
};

Properties​

description?​

optional description?: string

Defined in: packages/launchpad-sdk/dist/types/moderator.dto.d.ts:135

Optional description/label for the invite. Max 255 characters. Useful for tracking: "John - Friday shows"

expiresAt?​

optional expiresAt?: string

Defined in: packages/launchpad-sdk/dist/types/moderator.dto.d.ts:141

Optional expiration date in ISO 8601 format. If not provided, invite never expires.

Example​

"2025-12-31T23:59:59Z"

inviteScope?​

optional inviteScope?: InviteScope

Defined in: packages/launchpad-sdk/dist/types/moderator.dto.d.ts:118

Scope of the invite.

  • TOKEN: Access to specific token only (tokenName required)
  • ALL_OWNER_TOKENS: Blanket access to all owner's tokens (tokenName should be omitted)

Default​

'TOKEN'

Since​

5.8.0

role​

role: ModeratorRole

Defined in: packages/launchpad-sdk/dist/types/moderator.dto.d.ts:130

Role to grant to the moderator. Required.

tokenName?​

optional tokenName?: string

Defined in: packages/launchpad-sdk/dist/types/moderator.dto.d.ts:125

Token name to grant moderator access to. Required when inviteScope is 'TOKEN' (default). Should be omitted when inviteScope is 'ALL_OWNER_TOKENS'. Must be a token owned by the authenticated user.