Interface ReadyCheckSession

A live or completed ready check session.

interface ReadyCheckSession {
    color: string;
    completedAt: string;
    expiresAt: string;
    guildId: string;
    id: string;
    initiatorId: string;
    initiatorName: string;
    keyCombo: string;
    message: string;
    name: string;
    participants: ReadyCheckParticipant[];
    source: string;
    startedAt: string;
    status: "active" | "complete";
    target: ReadyCheckTarget;
    templateId: string;
}

Properties

color completedAt expiresAt guildId id initiatorId initiatorName keyCombo message name participants source startedAt status target templateId

Properties

color

color: string

Hex color for the UI.

completedAt

completedAt: string

ISO timestamp when the session completed.

expiresAt

expiresAt: string

ISO timestamp when the session expires.

guildId

guildId: string

ID of the guild the session belongs to.

id

id: string

Unique session identifier.

initiatorId

initiatorId: string

User ID of the member who started the session.

initiatorName

initiatorName: string

Display name of the member who started the session.

keyCombo

keyCombo: string

Keyboard shortcut hint.

message

message: string

Message shown to participants.

name

name: string

Display name for the session.

participants

participants: ReadyCheckParticipant[]

Participants in the session.

source

source: string

Origin of the session (e.g. app or bot).

startedAt

startedAt: string

ISO timestamp when the session started.

status

status: "active" | "complete"

Current lifecycle status of the session.

target

target: ReadyCheckTarget

Target audience configuration.

templateId

templateId: string

ID of the template this session was started from.

Settings

Member Visibility

On This Page

Properties