🧾 Classes
🤝 Interfaces
ClientOptionsCommandIncomingCommandOutgoingDeviceModelShortcutKeyComboVendorVoiceInputVoiceModeVoiceOutput
🏳️ Enums
⏩ Type Aliases
AuthorizeOptions
ts
AuthorizeOptions: { prompt?: "consent" | "none"; redirect_uri?: string; scopes: (OAuth2Scopes | `${OAuth2Scopes}`)[]; useRPCToken?: boolean }Defined in: packages/discord-rpc/Client.ts:15
ClientEvents
ts
ClientEvents: { connected: () => void; debug: (data: any[]) => void; disconnected: () => void; ready: () => void }Defined in: packages/discord-rpc/Client.ts:52
FormatFunction
ts
FormatFunction: (id: number) => [path: string, skipCheck?: boolean]Defined in: packages/discord-rpc/transport/IPC.ts:16
RPC_CMD
ts
RPC_CMD: "DISPATCH" | "SET_CONFIG" | "AUTHORIZE" | "AUTHENTICATE" | "GET_GUILD" | "GET_GUILDS" | "GET_CHANNEL" | "GET_CHANNELS" | "CREATE_CHANNEL_INVITE" | "GET_RELATIONSHIPS" | "GET_USER" | "SUBSCRIBE" | "UNSUBSCRIBE" | "SET_USER_VOICE_SETTINGS" | "SET_USER_VOICE_SETTINGS_2" | "SELECT_VOICE_CHANNEL" | "GET_SELECTED_VOICE_CHANNEL" | "SELECT_TEXT_CHANNEL" | "GET_VOICE_SETTINGS" | "SET_VOICE_SETTINGS_2" | "SET_VOICE_SETTINGS" | "SET_ACTIVITY" | "SEND_ACTIVITY_JOIN_INVITE" | "CLOSE_ACTIVITY_JOIN_REQUEST" | "ACTIVITY_INVITE_USER" | "ACCEPT_ACTIVITY_INVITE" | "OPEN_INVITE_DIALOG" | "INVITE_BROWSER" | "DEEP_LINK" | "CONNECTIONS_CALLBACK" | "BILLING_POPUP_BRIDGE_CALLBACK" | "BRAINTREE_POPUP_BRIDGE_CALLBACK" | "GIFT_CODE_BROWSER" | "GUILD_TEMPLATE_BROWSER" | "OVERLAY" | "BROWSER_HANDOFF" | "SET_CERTIFIED_DEVICES" | "GET_IMAGE" | "CREATE_LOBBY" | "UPDATE_LOBBY" | "DELETE_LOBBY" | "UPDATE_LOBBY_MEMBER" | "CONNECT_TO_LOBBY" | "DISCONNECT_FROM_LOBBY" | "SEND_TO_LOBBY" | "SEARCH_LOBBIES" | "CONNECT_TO_LOBBY_VOICE" | "DISCONNECT_FROM_LOBBY_VOICE" | "SET_OVERLAY_LOCKED" | "OPEN_OVERLAY_ACTIVITY_INVITE" | "OPEN_OVERLAY_GUILD_INVITE" | "OPEN_OVERLAY_VOICE_SETTINGS" | "VALIDATE_APPLICATION" | "GET_ENTITLEMENT_TICKET" | "GET_APPLICATION_TICKET" | "START_PURCHASE" | "START_PREMIUM_PURCHASE" | "GET_SKUS" | "GET_ENTITLEMENTS" | "GET_NETWORKING_CONFIG" | "NETWORKING_SYSTEM_METRICS" | "NETWORKING_PEER_METRICS" | "NETWORKING_CREATE_TOKEN" | "SET_USER_ACHIEVEMENT" | "GET_USER_ACHIEVEMENTS" | "USER_SETTINGS_GET_LOCALE" | "GET_ACTIVITY_JOIN_TICKET" | "SEND_GENERIC_EVENT" | "SEND_ANALYTICS_EVENT" | "OPEN_EXTERNAL_LINK" | "CAPTURE_LOG" | "ENCOURAGE_HW_ACCELERATION" | "SET_ORIENTATION_LOCK_STATE"Defined in: packages/discord-rpc/structures/Transport.ts:109
RPC_EVT
ts
RPC_EVT: "CURRENT_USER_UPDATE" | "GUILD_STATUS" | "GUILD_CREATE" | "CHANNEL_CREATE" | "RELATIONSHIP_UPDATE" | "VOICE_CHANNEL_SELECT" | "VOICE_STATE_CREATE" | "VOICE_STATE_DELETE" | "VOICE_STATE_UPDATE" | "VOICE_SETTINGS_UPDATE" | "VOICE_SETTINGS_UPDATE_2" | "VOICE_CONNECTION_STATUS" | "SPEAKING_START" | "SPEAKING_STOP" | "GAME_JOIN" | "GAME_SPECTATE" | "ACTIVITY_JOIN" | "ACTIVITY_JOIN_REQUEST" | "ACTIVITY_SPECTATE" | "ACTIVITY_INVITE" | "ACTIVITY_PIP_MODE_UPDATE" | "NOTIFICATION_CREATE" | "MESSAGE_CREATE" | "MESSAGE_UPDATE" | "MESSAGE_DELETE" | "LOBBY_DELETE" | "LOBBY_UPDATE" | "LOBBY_MEMBER_CONNECT" | "LOBBY_MEMBER_DISCONNECT" | "LOBBY_MEMBER_UPDATE" | "LOBBY_MESSAGE" | "OVERLAY" | "OVERLAY_UPDATE" | "ENTITLEMENT_CREATE" | "ENTITLEMENT_DELETE" | "USER_ACHIEVEMENT_UPDATE" | "VOICE_CHANNEL_EFFECT_SEND" | "THERMAL_STATE_UPDATE" | "READY" | "ERROR"Defined in: packages/discord-rpc/structures/Transport.ts:184
SetActivity
ts
SetActivity: { buttons?: GatewayActivityButton[]; details?: string; endTimestamp?: number | Date; instance?: boolean; joinSecret?: string; largeImageKey?: string; largeImageText?: string; matchSecret?: string; partyId?: string; partyMax?: number; partySize?: number; smallImageKey?: string; smallImageText?: string; spectateSecret?: string; startTimestamp?: number | Date; state?: string; type?: ActivityType.Playing | ActivityType.Watching }Defined in: packages/discord-rpc/structures/ClientUser.ts:9
SetActivityResponse
ts
SetActivityResponse: { application_id: string; buttons?: string[]; metadata: { button_urls?: string[] }; name: string; state?: string; type: ActivityType }Defined in: packages/discord-rpc/structures/ClientUser.ts:30
TransportEvents
ts
TransportEvents: { close: (reason?: string | { code: number; message: string }) => void; message: (message: CommandIncoming) => void; open: () => void; ping: () => void }Defined in: packages/discord-rpc/structures/Transport.ts:241
TransportOptions
ts
TransportOptions: { client: Client }Defined in: packages/discord-rpc/structures/Transport.ts:260