Discord Social SDK API Reference¶

Complete API reference for the Discord Social SDK module.

IVXDiscordManager¶

Main entry point for Discord SDK initialization, OAuth2 account linking, and social settings.

Properties¶

Methods¶

Initialize¶

public void Initialize(IVXDiscordConfig config)

Initializes the Discord Social SDK with the provided configuration asset.

Parameters: - config - IVXDiscordConfig ScriptableObject with application settings

Example:

IVXDiscordManager.Instance.Initialize(discordConfig);

LinkAccount¶

public void LinkAccount()

Starts the OAuth2 account linking flow using the configured redirect URI.

Example:

IVXDiscordManager.Instance.OnAccountLinked += (id, name) => Debug.Log($"Linked: {name}");
IVXDiscordManager.Instance.LinkAccount();

StartMobileOAuth2Flow¶

public void StartMobileOAuth2Flow(string redirectScheme, Action<bool> onComplete)

Starts the mobile OAuth2 + PKCE linking flow with the app's custom URL scheme.

Parameters: - redirectScheme - Custom URL scheme (e.g. "mygame://") - onComplete - Callback with success status

Example:

IVXDiscordManager.Instance.StartMobileOAuth2Flow("mygame://", success =>
{
    Debug.Log(success ? "Mobile link succeeded" : "Mobile link failed");
});

StartConsoleOAuth2Flow¶

public void StartConsoleOAuth2Flow(Action<string> onCodeReceived, Action<bool> onComplete)

Starts the console device-code OAuth2 flow. Display the received code to the user on screen.

Parameters: - onCodeReceived - Callback delivering the device code string - onComplete - Callback with success status

Example:

IVXDiscordManager.Instance.StartConsoleOAuth2Flow(
    code => ShowDeviceCodeUi(code),
    success => Debug.Log($"Console link: {success}"));

CreateProvisionalAccount¶

public void CreateProvisionalAccount(Action<bool> onComplete)

Creates a provisional Discord-backed identity for social features without full OAuth.

Parameters: - onComplete - Callback with success status

MergeProvisionalAccount¶

public void MergeProvisionalAccount(string externalAuthToken, Action<bool> onComplete)

Upgrades a provisional account to a fully linked account using an external auth token.

Parameters: - externalAuthToken - Bearer or backend auth token - onComplete - Callback with success status

SetPublisherId¶

public void SetPublisherId(string publisherId)

Sets the publisher ID at runtime for cross-game shared authentication.

Parameters: - publisherId - Publisher identifier string

UpdateToken¶

public void UpdateToken(string newBearerToken)

Refreshes the Discord bearer token after external browser or backend renewal.

Parameters: - newBearerToken - New OAuth2 bearer token

RegisterAuthorizeRequestCallback¶

public void RegisterAuthorizeRequestCallback(Action callback)

Registers a callback invoked when Discord requests authorization from the client (entry-point linking).

Parameters: - callback - Action to invoke when authorization is requested

RemoveAuthorizeRequestCallback¶

public void RemoveAuthorizeRequestCallback()

Removes the authorization request callback, blocking entry-point linking during gameplay.

OpenConnectedGamesSettingsInDiscord¶

public void OpenConnectedGamesSettingsInDiscord()

Opens the Connected Games settings page in the Discord client.

OpenUserProfileInDiscord¶

public void OpenUserProfileInDiscord(string userId)

Opens a user's profile page in the Discord client.

Parameters: - userId - Discord user ID to view

Events¶

IVXDiscordPresence¶

Rich Presence management for activity display, party info, buttons, and RPC-only mode.

Properties¶

Methods¶

SetActivity¶

public void SetActivity(string details, string state)

Sets the Rich Presence activity lines.

Parameters: - details - Primary activity text (e.g. "Ranked Match") - state - Secondary state text (e.g. "Score: 1,500")

Example:

IVXDiscordPresence.Instance.SetActivity("Ranked Match", "Score: 1,500");

SetParty¶

public void SetParty(string partyId, int currentSize, int maxSize, string joinSecret = null)

Sets party information for group invites.

Parameters: - partyId - Unique party identifier - currentSize - Current number of members - maxSize - Maximum party capacity - joinSecret - Secret used for join invites (optional)

StartTimer¶

public void StartTimer()

Starts the elapsed-time counter on the Rich Presence display.

ClearPresence¶

public void ClearPresence()

Removes all Rich Presence data from the user's Discord profile.

SetFieldUrls¶

public void SetFieldUrls(string stateUrl = null, string detailsUrl = null)

Sets clickable URLs on state and details lines.

Parameters: - stateUrl - URL for the state line - detailsUrl - URL for the details line

SetAssetUrls¶

public void SetAssetUrls(string largeUrl = null, string smallUrl = null)

Sets clickable URLs on the large and small image assets.

Parameters: - largeUrl - URL for the large image - smallUrl - URL for the small image

SetStatusDisplayType¶

public void SetStatusDisplayType(IVXStatusDisplayType displayType)

Controls which fields appear in the presence card (Name, State, Details).

Parameters: - displayType - Display type enum value

SetSupportedPlatforms¶

public void SetSupportedPlatforms(IVXActivityPlatforms platforms)

Restricts which platforms show the activity.

Parameters: - platforms - Bitflag combination of Desktop, Mobile, etc.

AddButton¶

public void AddButton(string label, string url)

Adds a clickable button to the presence card (max 2).

Parameters: - label - Button text - url - Button URL

ClearButtons¶

public void ClearButtons()

Removes all buttons from the presence card.

SetInviteCoverImage¶

public void SetInviteCoverImage(string assetKey)

Sets the cover art image for invite embeds.

Parameters: - assetKey - Discord Rich Presence art asset key

SetSmallImage¶

public void SetSmallImage(string assetKey, string text)

Sets the small overlay image and hover text.

Parameters: - assetKey - Art asset key - text - Hover tooltip text

InitializeRPCOnly¶

public void InitializeRPCOnly(long applicationId)

Initializes presence in desktop RPC-only mode without full SDK authentication.

Parameters: - applicationId - Discord application ID as a long

SyncFromGameState¶

public void SyncFromGameState()

Reads current IVX game systems and pushes presence automatically.

IVXDiscordVoice¶

Voice chat management including mute, deafen, VAD, and raw audio callbacks.

Properties¶

Methods¶

JoinCall¶

public void JoinCall(string lobbyId)

Joins the voice channel associated with a lobby.

Parameters: - lobbyId - Lobby identifier

LeaveCall¶

public void LeaveCall()

Leaves the current voice call.

AutoJoinFromLobby¶

public void AutoJoinFromLobby()

Automatically joins voice when the player enters a lobby with voice enabled.

SetSelfMute / SetSelfDeafen¶

public void SetSelfMute(bool muted)
public void SetSelfDeafen(bool deafened)

Toggles local mute or deafen state.

Parameters: - muted / deafened - State flag

SetInputVolume / SetOutputVolume¶

public void SetInputVolume(float volume)
public void SetOutputVolume(float volume)

Adjusts microphone input or speaker output volume (0.0 -- 1.0).

SetParticipantVolume¶

public void SetParticipantVolume(string userId, float volume)

Adjusts volume for a specific participant.

Parameters: - userId - Target user - volume - Volume level (0.0 -- 1.0)

SetVADThreshold¶

public void SetVADThreshold(bool useCustom, float thresholdDb = -35f)

Configures Voice Activity Detection threshold.

Parameters: - useCustom - Use custom threshold instead of auto - thresholdDb - Threshold in decibels

JoinCallWithAudioCallbacks¶

public void JoinCallWithAudioCallbacks(
    string lobbyId,
    IVXAudioReceivedCallback onReceived,
    IVXAudioCapturedCallback onCaptured)

Joins voice with raw PCM audio callbacks for FMOD, Wwise, or custom audio pipelines.

Parameters: - lobbyId - Lobby identifier - onReceived - Delegate for incoming audio frames - onCaptured - Delegate for captured microphone frames

SetSelfMuteAll / SetSelfDeafenAll / EndAllCalls¶

public void SetSelfMuteAll(bool muted)
public void SetSelfDeafenAll(bool deafened)
public void EndAllCalls()

Global voice controls across all active calls.

GetParticipantVoiceState¶

public IVXVoiceState GetParticipantVoiceState(string userId)

Returns the voice state (muted, deafened, speaking) for a participant.

Returns: IVXVoiceState or null

Events¶

IVXDiscordLobby¶

Lobby lifecycle, metadata, idle timeout, and text chat.

Properties¶

Methods¶

CreateOrJoinLobby¶

public void CreateOrJoinLobby(string secret, Dictionary<string, string> metadata = null)

Creates or joins a lobby by secret, with optional metadata.

Parameters: - secret - Lobby join secret - metadata - Key-value metadata pairs

CreateOrJoinLobbyWithMetadata¶

public void CreateOrJoinLobbyWithMetadata(
    string secret,
    Dictionary<string, string> lobbyMetadata,
    Dictionary<string, string> userMetadata,
    Action<IVXDiscordLobbyInfo> onComplete)

Creates or joins with separate lobby-level and user-level metadata.

Parameters: - secret - Lobby secret - lobbyMetadata - Lobby-wide metadata - userMetadata - Per-user metadata - onComplete - Callback with lobby info

BridgeIVXRoom¶

public void BridgeIVXRoom(string ivxRoomId, Dictionary<string, string> roomMetadata = null)

Bridges an IntelliVerseX multiplayer room to a Discord lobby.

Parameters: - ivxRoomId - IVX room identifier - roomMetadata - Optional metadata for the bridge

UpdateLobbyMemberMetadata¶

public void UpdateLobbyMemberMetadata(string json)

Updates the local user's metadata in the current lobby.

Parameters: - json - JSON string of metadata key-value pairs

SetLobbyIdleTimeout¶

public void SetLobbyIdleTimeout(int seconds)

Sets the idle timeout before the lobby is automatically disbanded.

Parameters: - seconds - Timeout in seconds (default 300, max 604800)

SendMessage¶

public void SendMessage(string content)

Sends a text chat message to the current lobby.

FetchChatHistory¶

public void FetchChatHistory(int limit, Action<List<IVXLobbyChatMessage>> callback)

Fetches recent chat history for the current lobby.

Parameters: - limit - Maximum messages to retrieve - callback - Callback with message list

LeaveLobby¶

public void LeaveLobby()

Leaves the current lobby.

GetLobbyInfo¶

public IVXDiscordLobbyInfo GetLobbyInfo()

Returns the current lobby information snapshot.

Returns: IVXDiscordLobbyInfo with LobbyId, Secret, MemberCount, VoiceActive, Metadata, LobbyMetadata, MemberIds

Events¶

IVXDiscordFriends¶

Unified friends list with dual-layer relationship APIs for Discord and game (Nakama) layers.

Properties¶

Methods¶

Refresh¶

public void Refresh()

Refreshes the unified friends list from both Discord and game backends.

Example:

IVXDiscordFriends.Instance.OnFriendsUpdated += list => BindFriendsUi(list);
IVXDiscordFriends.Instance.Refresh();

GetInGameFriends¶

public List<IVXUnifiedFriend> GetInGameFriends()

Returns friends who are currently in the game.

GetBySource¶

public List<IVXUnifiedFriend> GetBySource(IVXFriendSource source)

Filters friends by source (Discord, Game, Both).

SendGameFriendRequest / SendDiscordFriendRequest¶

public void SendGameFriendRequest(string username)
public void SendDiscordFriendRequest(string username)

Sends a friend request via the game backend or Discord respectively.

AcceptGameFriendRequest / AcceptDiscordFriendRequest¶

public void AcceptGameFriendRequest(string userId)
public void AcceptDiscordFriendRequest(string userId)

Accepts an incoming friend request.

BlockUser / UnblockUser¶

public void BlockUser(string userId)
public void UnblockUser(string userId)

Blocks or unblocks a user across both layers.

GetBlockedUsers / GetPendingRequests¶

public List<IVXUnifiedFriend> GetBlockedUsers()
public List<IVXUnifiedFriend> GetPendingRequests()

Returns blocked users or pending friend requests for UI lists.

Events¶

IVXDiscordMessages¶

Direct message operations: send, edit, history, summaries, and Discord client integration.

Methods¶

SendDM¶

public void SendDM(string recipientId, string message, Action onSuccess = null, Action<string> onError = null)

Sends a direct message to a Discord user.

Parameters: - recipientId - Target Discord user ID - message - Message content - onSuccess - Success callback - onError - Error callback with message

EditDM¶

public void EditDM(string recipientId, string messageId, string newContent, Action onSuccess = null, Action<string> onError = null)

Edits a previously sent direct message.

GetDMHistory¶

public void GetDMHistory(string recipientId, int limit, Action<List<IVXDirectMessage>> onComplete)

Retrieves DM conversation history.

Parameters: - recipientId - Discord user ID - limit - Maximum messages to fetch - onComplete - Callback with message list

GetDMSummaries¶

public void GetDMSummaries(Action<List<IVXDMSummary>> onComplete)

Retrieves summaries of all DM conversations.

SetShowingChat¶

public void SetShowingChat(bool showing)

Suppresses desktop notifications while the in-game chat is focused.

OpenMessageInDiscord¶

public void OpenMessageInDiscord(string messageId)

Opens a specific message in the Discord client.

OpenDMSettingsInDiscord¶

public void OpenDMSettingsInDiscord()

Opens the DM-related settings page in the Discord client.

Events¶

IVXDiscordModeration¶

Moderation tools for message metadata processing, voice capture, and user reporting.

Methods¶

ProcessModerationMetadata¶

public IVXModerationDecision ProcessModerationMetadata(string messageId, Dictionary<string, string> metadata)

Parses moderation metadata keys (action, reason, severity, flagged) into a structured decision.

Returns: IVXModerationDecision with Action (Show, Hide, Blur, Replace), Reason, Severity, Replacement

StartVoiceModerationCapture¶

public void StartVoiceModerationCapture(string lobbyId)

Begins capturing voice audio for moderation analysis.

StopVoiceModerationCapture¶

public void StopVoiceModerationCapture()

Stops voice moderation capture.

ReportUser¶

public void ReportUser(string userId, string reason, Action<bool> onComplete = null)

Submits a user report to Discord.

Parameters: - userId - Reported user ID - reason - Report reason text - onComplete - Callback with success status

EnableAutoModeration¶

public void EnableAutoModeration(bool enabled)

Toggles automatic moderation processing at runtime.

Properties¶

Events¶

IVXDiscordLinkedChannels¶

Bridges in-game chat to Discord server text channels.

Methods¶

LinkChannel¶

public void LinkChannel(string lobbyId, string guildId, string channelId)

Links a lobby to a Discord server text channel for bidirectional messaging.

Parameters: - lobbyId - Lobby identifier - guildId - Discord server (guild) ID - channelId - Discord channel ID

SendToLinkedChannel¶

public void SendToLinkedChannel(string message)

Sends a message to the linked Discord channel.

UnlinkChannel¶

public void UnlinkChannel()

Removes the channel link.

IVXDiscordConfig¶

ScriptableObject holding all Discord integration settings.

Properties¶

Data Models¶

IVXUnifiedFriend¶

IVXDirectMessage¶

IVXDMSummary¶

IVXDiscordLobbyInfo¶

See Also¶

• Discord Module Guide
• Social Module
• Backend Module