APIConfig class

Annotations
  • @JsonSerializable(checked: true, createToJson: true, disallowUnrecognizedKeys: false, explicitToJson: true)

Constructors

APIConfig({bool voiceEnableDegradation = false, bool voiceEnableReceiverLimiting = true, required String address, required Set<APIConfigAnnouncement> announcements, String appName = 'VrChat', required String buildVersionTag, required String clientApiKey, int clientBPSCeiling = 18432, int clientDisconnectTimeout = 30000, int clientReservedPlayerBPS = 7168, int clientSentCountAllowance = 15, required String contactEmail, required String copyrightEmail, required int currentTOSVersion, required String defaultAvatar, required DeploymentGroup deploymentGroup, required String devAppVersionStandalone, required String devDownloadLinkWindows, required String devSdkUrl, required String devSdkVersion, required String devServerVersionStandalone, required DateTime disCountdown, bool disableAvatarCopying = false, bool disableAvatarGating = false, bool disableCommunityLabs = false, bool disableCommunityLabsPromotion = false, bool disableEmail = false, bool disableEventStream = false, bool disableFeedbackGating = false, bool disableFrontendBuilds = false, bool disableHello = false, bool disableOculusSubs = false, bool disableRegistration = false, bool disableSteamNetworking = true, bool disableTwoFactorAuth = false, bool disableUdon = false, bool disableUpgradeAccount = false, required String downloadLinkWindows, required APIConfigDownloadURLList downloadUrls, required Set<DynamicContentRow> dynamicWorldRows, required APIConfigEvents events, required String gearDemoRoomId, required String homeWorldId, String homepageRedirectTarget = 'https://hello.vrchat.com', required String hubWorldId, required String jobsEmail, required String messageOfTheDay, required String moderationEmail, required int moderationQueryPeriod, required String notAllowedToSelectAvatarInPrivateWorldMessage, required String plugin, required String releaseAppVersionStandalone, required String releaseSdkUrl, required String releaseSdkVersion, required String releaseServerVersionStandalone, required String sdkDeveloperFaqUrl, required String sdkDiscordUrl, required String sdkNotAllowedToPublishMessage, required String sdkUnityVersion, required String serverName, required String supportEmail, required String timeOutWorldId, required String tutorialWorldId, required int updateRateMsMaximum, required int updateRateMsMinimum, required int updateRateMsNormal, required int updateRateMsUdonManual, required int uploadAnalysisPercent, required List<String> urlList, bool useReliableUdpForVoice = false, required int userUpdatePeriod, required int userVerificationDelay, required int userVerificationRetry, required int userVerificationTimeout, required String viveWindowsUrl, required List<String> whiteListedAssetUrls, required int worldUpdatePeriod, required String playerUrlResolverHash, required String playerUrlResolverVersion})
Returns a new APIConfig instance.
APIConfig.fromJson(Map<String, dynamic> json)
factory

Properties

address → String
VRChat's office address
final
announcements → Set<APIConfigAnnouncement>
Public Announcements
final
appName → String
Game name
final
buildVersionTag → String
Build tag of the API server
final
clientApiKey → String
apiKey to be used for all other requests
final
clientBPSCeiling → int
Unknown
final
clientDisconnectTimeout → int
Unknown
final
clientReservedPlayerBPS → int
Unknown
final
clientSentCountAllowance → int
Unknown
final
contactEmail → String
VRChat's contact email
final
copyrightEmail → String
VRChat's copyright-issues-related email
final
currentTOSVersion → int
Current version number of the Terms of Service
final
defaultAvatar → String
final
deploymentGroup → DeploymentGroup
final
devAppVersionStandalone → String
Version number for game development build
final
devDownloadLinkWindows → String
Developer Download link
final
devSdkUrl → String
Link to download the development SDK, use downloadUrls instead
final
devSdkVersion → String
Version of the development SDK
final
devServerVersionStandalone → String
Version number for server development build
final
disableAvatarCopying → bool
Toggles if copying avatars should be disabled
final
disableAvatarGating → bool
Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the system_avatar_access Tag or admin_avatar_access Tag
final
disableCommunityLabs → bool
Toggles if the Community Labs should be disabled
final
disableCommunityLabsPromotion → bool
Toggles if promotion out of Community Labs should be disabled
final
disableEmail → bool
Unknown
final
disableEventStream → bool
Toggles if Analytics should be disabled.
final
disableFeedbackGating → bool
Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the system_feedback_access Tag.
final
disableFrontendBuilds → bool
Unknown, probably toggles compilation of frontend web builds? So internal flag?
final
disableHello → bool
Unknown
final
disableOculusSubs → bool
Toggles if signing up for Subscriptions in Oculus is disabled or not.
final
disableRegistration → bool
Toggles if new user account registration should be disabled.
final
disableSteamNetworking → bool
Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead.
final
disableTwoFactorAuth → bool
Toggles if 2FA should be disabled.
final
disableUdon → bool
Toggles if Udon should be universally disabled in-game.
final
disableUpgradeAccount → bool
Toggles if account upgrading "linking with Steam/Oculus" should be disabled.
final
disCountdown → DateTime
Unknown, "dis" maybe for disconnect?
final
downloadLinkWindows → String
Download link for game on the Oculus Rift website.
final
downloadUrls → APIConfigDownloadURLList
final
dynamicWorldRows → Set<DynamicContentRow>
Array of DynamicWorldRow objects, used by the game to display the list of world rows
final
events → APIConfigEvents
final
gearDemoRoomId → String
Unknown
final
hashCode → int
The hash code for this object.
no setteroverride
homepageRedirectTarget → String
Redirect target if you try to open the base API domain in your browser
final
homeWorldId → String
WorldID be "offline" on User profiles if you are not friends with that user.
final
hubWorldId → String
WorldID be "offline" on User profiles if you are not friends with that user.
final
jobsEmail → String
VRChat's job application email
final
messageOfTheDay → String
MOTD
final
moderationEmail → String
VRChat's moderation related email
final
moderationQueryPeriod → int
Unknown
final
notAllowedToSelectAvatarInPrivateWorldMessage → String
Used in-game to notify a user they aren't allowed to select avatars in private worlds
final
playerUrlResolverHash → String
Currently used youtube-dl.exe hash in SHA-256-delimited format
final
playerUrlResolverVersion → String
Currently used youtube-dl.exe version
final
plugin → String
Extra plugin to run in each instance
final
releaseAppVersionStandalone → String
Version number for game release build
final
releaseSdkUrl → String
Link to download the release SDK
final
releaseSdkVersion → String
Version of the release SDK
final
releaseServerVersionStandalone → String
Version number for server release build
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkDeveloperFaqUrl → String
Link to the developer FAQ
final
sdkDiscordUrl → String
Link to the official VRChat Discord
final
sdkNotAllowedToPublishMessage → String
Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet
final
sdkUnityVersion → String
Unity version supported by the SDK
final
serverName → String
Server name of the API server currently responding
final
supportEmail → String
VRChat's support email
final
timeOutWorldId → String
WorldID be "offline" on User profiles if you are not friends with that user.
final
tutorialWorldId → String
WorldID be "offline" on User profiles if you are not friends with that user.
final
updateRateMsMaximum → int
Unknown
final
updateRateMsMinimum → int
Unknown
final
updateRateMsNormal → int
Unknown
final
updateRateMsUdonManual → int
Unknown
final
uploadAnalysisPercent → int
Unknown
final
urlList → List<String>
List of allowed URLs that bypass the "Allow untrusted URL's" setting in-game
final
useReliableUdpForVoice → bool
Unknown
final
userUpdatePeriod → int
Unknown
final
userVerificationDelay → int
Unknown
final
userVerificationRetry → int
Unknown
final
userVerificationTimeout → int
Unknown
final
viveWindowsUrl → String
Download link for game on the Steam website.
final
voiceEnableDegradation → bool
Unknown, probably voice optimization testing
final
voiceEnableReceiverLimiting → bool
Unknown, probably voice optimization testing
final
whiteListedAssetUrls → List<String>
List of allowed URLs that are allowed to host avatar assets
final
worldUpdatePeriod → int
Unknown
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override