Dissonity
Unity SDK for Discord activities
Loading...
Searching...
No Matches
Dissonity.SdkConfiguration< TRequest, TResponse > Class Template Referenceabstract
Inheritance diagram for Dissonity.SdkConfiguration< TRequest, TResponse >:

Public Member Functions

Type GetRequestType ()
 
Type GetResponseType ()
 

Properties

long ClientId [get]
 Your application id.

https://discord.com/developers/applications.
 
string[] OauthScopes [get]
 The OAuth2 scopes your app needs.

https://discord.com/developers/docs/topics/oauth2.
 
string TokenRequestPath [get]
 Path where your backend exchanges an authorization code for an access token.
 
virtual bool DisableConsoleLogOverride = true [get]
 https://discord.com/developers/docs/activities/development-guides#disabling-logging

Defaults to true.
 
virtual bool LazyHiRpcLoad = false [get]
 Load the hiRPC module on Api.Initialize, rather than before loading the game.

Defaults to false.
 
virtual bool DisableDissonityInfoLogs = false [get]
 Disable information logs.

It's recommended to keep logs enabled during testing.
 
virtual MappingBuilder[] Mappings = {} [get]
 Mappings to patch before initialization.

https://discord.com/developers/docs/activities/development-guides#using-external-resources.
 
virtual PatchUrlMappingsConfigBuilder PatchUrlMappingsConfig [get]
 Patch url mappings configuration.

https://discord.com/developers/docs/activities/development-guides#using-external-resources.
 
virtual bool SynchronizeUser = false [get]
 Keep Api.SyncedUser up to date by automatically subscribing to CurrentUserUpdate .
 
virtual bool SynchronizeGuildMemberRpc = false [get]
 Keep Api.SyncedGuildMemberRpc up to date by automatically subscribing to CurrentGuildMemberUpdate .
 
virtual ScreenResolution DesktopResolution = ScreenResolution.Max [get]
 How app resolution will be handled on desktop.

Defaults to ScreenResolution.Max
 
virtual ScreenResolution MobileResolution = ScreenResolution.Max [get]
 How app resolution will be handled on mobile.

Defaults to ScreenResolution.Max
 
virtual ScreenResolution BrowserResolution = ScreenResolution.Dynamic [get]
 How app resolution will be handled in a browser outside of Discord.

Defaults to ScreenResolution.Dynamic
 

Member Function Documentation

◆ GetRequestType()

Type Dissonity.SdkConfiguration< TRequest, TResponse >.GetRequestType ( )
inline

◆ GetResponseType()

Type Dissonity.SdkConfiguration< TRequest, TResponse >.GetResponseType ( )
inline

Property Documentation

◆ BrowserResolution

virtual ScreenResolution Dissonity.SdkConfiguration< TRequest, TResponse >.BrowserResolution = ScreenResolution.Dynamic
get

How app resolution will be handled in a browser outside of Discord.

Defaults to ScreenResolution.Dynamic

◆ ClientId

long Dissonity.SdkConfiguration< TRequest, TResponse >.ClientId
getabstract

◆ DesktopResolution

virtual ScreenResolution Dissonity.SdkConfiguration< TRequest, TResponse >.DesktopResolution = ScreenResolution.Max
get

How app resolution will be handled on desktop.

Defaults to ScreenResolution.Max

◆ DisableConsoleLogOverride

virtual bool Dissonity.SdkConfiguration< TRequest, TResponse >.DisableConsoleLogOverride = true
get

◆ DisableDissonityInfoLogs

virtual bool Dissonity.SdkConfiguration< TRequest, TResponse >.DisableDissonityInfoLogs = false
get

Disable information logs.

It's recommended to keep logs enabled during testing.

◆ LazyHiRpcLoad

virtual bool Dissonity.SdkConfiguration< TRequest, TResponse >.LazyHiRpcLoad = false
get

Load the hiRPC module on Api.Initialize, rather than before loading the game.

Defaults to false.

◆ Mappings

virtual MappingBuilder [] Dissonity.SdkConfiguration< TRequest, TResponse >.Mappings = {}
get

◆ MobileResolution

virtual ScreenResolution Dissonity.SdkConfiguration< TRequest, TResponse >.MobileResolution = ScreenResolution.Max
get

How app resolution will be handled on mobile.

Defaults to ScreenResolution.Max

◆ OauthScopes

string [] Dissonity.SdkConfiguration< TRequest, TResponse >.OauthScopes
getabstract

The OAuth2 scopes your app needs.

https://discord.com/developers/docs/topics/oauth2.

◆ PatchUrlMappingsConfig

virtual PatchUrlMappingsConfigBuilder Dissonity.SdkConfiguration< TRequest, TResponse >.PatchUrlMappingsConfig
get
Initial value:
= new()
{
PatchFetch = true,
PatchWebSocket = true,
PatchXhr = true,
PatchSrcAttributes = false
}

Patch url mappings configuration.

https://discord.com/developers/docs/activities/development-guides#using-external-resources.

◆ SynchronizeGuildMemberRpc

virtual bool Dissonity.SdkConfiguration< TRequest, TResponse >.SynchronizeGuildMemberRpc = false
get

Keep Api.SyncedGuildMemberRpc up to date by automatically subscribing to CurrentGuildMemberUpdate .

◆ SynchronizeUser

virtual bool Dissonity.SdkConfiguration< TRequest, TResponse >.SynchronizeUser = false
get

Keep Api.SyncedUser up to date by automatically subscribing to CurrentUserUpdate .

◆ TokenRequestPath

string Dissonity.SdkConfiguration< TRequest, TResponse >.TokenRequestPath
getabstract

Path where your backend exchanges an authorization code for an access token.


The documentation for this class was generated from the following file: