Skip to content

@tavora/sdk / DiscordState

Interface: DiscordState ​

Defined in: packages/sdk/src/protocol.ts:520

The discord connector's connection to the Discord app on this PC, with Tavora's Discord sign-in. The connection runs while a panel of a module granted the connector has asked for it.

Properties ​

canControl ​

canControl: boolean

Defined in: packages/sdk/src/protocol.ts:536

The sign-in may mute and deafen the user (SET_VOICE_SETTINGS). Sign-ins made before Tavora 0.5.11 can't until allowControl().


canSaveSignIn ​

canSaveSignIn: boolean

Defined in: packages/sdk/src/protocol.ts:538

False where this PC can't keep the sign-in safely, so it lasts only until Tavora closes.


error ​

error: "failed" | "offline" | "not-approved" | "no-code" | "no-sign-in" | null

Defined in: packages/sdk/src/protocol.ts:532

For error: not-approved (the user declined in Discord), no-code (Discord gave no sign-in code), offline (discord.com could not be reached), no-sign-in (discord.com refused the sign-in), failed.


status ​

status: "connecting" | "not-running" | "signed-out" | "approving" | "connected" | "error"

Defined in: packages/sdk/src/protocol.ts:527

connecting: looking for the Discord app and signing in. not-running: no Discord app was found; Tavora keeps looking. signed-out: Tavora was never approved in Discord, or the user signed out; connect() asks. approving: Discord shows its approval pop-up. connected: commands and events work. error: the last sign-in failed (see error); connect() tries again.


user ​

user: { id: string; name: string; } | null

Defined in: packages/sdk/src/protocol.ts:534

Who Tavora is signed in to Discord as, once connected. Names come from Discord; show them as text only.

For Tavora 0.23.9 and @tavora/sdk 0.3.3. Code under the MIT License. The Tavora name and logo are not covered by it.