|
2 | 2 |
|
3 | 3 | # APIConfig |
4 | 4 |
|
5 | | - |
| 5 | +Global configuration for various features. |
6 | 6 |
|
7 | 7 | ## Properties |
8 | 8 |
|
9 | 9 | | Name | Type | Description | Notes | |
10 | 10 | |------------ | ------------- | ------------- | -------------| |
| 11 | +|**campaignStatus** | **String** | The current platform-wide event taking place | | |
| 12 | +|**disableBackgroundPreloads** | **Boolean** | Toggles if certain assets are preloaded in the background | | |
| 13 | +|**locationGiftingNonSubPrioEnabled** | **Boolean** | Toggles whether users without a current VRC+ subscription are priority recipients for gift drops | | |
11 | 14 | |**voiceEnableDegradation** | **Boolean** | Unknown, probably voice optimization testing | | |
12 | 15 | |**voiceEnableReceiverLimiting** | **Boolean** | Unknown, probably voice optimization testing | | |
13 | 16 | |**accessLogsUrls** | [**APIConfigAccessLogsUrls**](APIConfigAccessLogsUrls.md) | | | |
|
17 | 20 | |**ageVerificationStatusVisible** | **Boolean** | | | |
18 | 21 | |**analysisMaxRetries** | **Integer** | Max retries for avatar analysis requests | | |
19 | 22 | |**analysisRetryInterval** | **Integer** | Interval between retries for avatar analysis requests | | |
20 | | -|**announcements** | [**Set<APIConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements | | |
21 | 23 | |**analyticsSegmentNewUIPctOfUsers** | **Integer** | Unknown | | |
22 | 24 | |**analyticsSegmentNewUISalt** | **String** | Unknown | | |
| 25 | +|**announcements** | [**Set<APIConfigAnnouncement>**](APIConfigAnnouncement.md) | Public Announcements | | |
| 26 | +|**audioConfig** | [**APIConfigAudioConfig**](APIConfigAudioConfig.md) | | [optional] | |
23 | 27 | |**availableLanguageCodes** | **List<String>** | List of supported Languages | | |
24 | 28 | |**availableLanguages** | **List<String>** | List of supported Languages | | |
25 | 29 | |**avatarPerfLimiter** | [**APIConfigAvatarPerfLimiter**](APIConfigAvatarPerfLimiter.md) | | | |
|
43 | 47 | |**constants** | [**APIConfigConstants**](APIConfigConstants.md) | | | |
44 | 48 | |**contactEmail** | **String** | VRChat's contact email | | |
45 | 49 | |**copyrightEmail** | **String** | VRChat's copyright-issues-related email | | |
46 | | -|**currentPrivacyVersion** | **Integer** | Current version number of the Privacy Agreement | [optional] | |
| 50 | +|**copyrightFormUrl** | **String** | VRChat's DMCA claim webform url | | |
| 51 | +|**currentPrivacyVersion** | **Integer** | Current version number of the Privacy Agreement | | |
47 | 52 | |**currentTOSVersion** | **Integer** | Current version number of the Terms of Service | | |
48 | 53 | |**defaultAvatar** | **String** | | | |
49 | 54 | |**defaultStickerSet** | **String** | | | |
|
54 | 59 | |**disableAVProInProton** | **Boolean** | Unknown | [optional] | |
55 | 60 | |**disableAvatarCopying** | **Boolean** | Toggles if copying avatars should be disabled | | |
56 | 61 | |**disableAvatarGating** | **Boolean** | 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 | | |
| 62 | +|**disableCaptcha** | **Boolean** | Unknown | [optional] | |
57 | 63 | |**disableCommunityLabs** | **Boolean** | Toggles if the Community Labs should be disabled | | |
58 | 64 | |**disableCommunityLabsPromotion** | **Boolean** | Toggles if promotion out of Community Labs should be disabled | | |
59 | 65 | |**disableEmail** | **Boolean** | Unknown | | |
60 | | -|**disableCaptcha** | **Boolean** | Unknown | [optional] | |
61 | 66 | |**disableEventStream** | **Boolean** | Toggles if Analytics should be disabled. | | |
62 | 67 | |**disableFeedbackGating** | **Boolean** | 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. | | |
63 | 68 | |**disableFrontendBuilds** | **Boolean** | Unknown, probably toggles compilation of frontend web builds? So internal flag? | | |
|
72 | 77 | |**downloadLinkWindows** | **String** | Download link for game on the Oculus Rift website. | | |
73 | 78 | |**downloadUrls** | [**APIConfigDownloadURLList**](APIConfigDownloadURLList.md) | | | |
74 | 79 | |**dynamicWorldRows** | [**Set<DynamicContentRow>**](DynamicContentRow.md) | Array of DynamicWorldRow objects, used by the game to display the list of world rows | | |
75 | | -|**economyPauseEnd** | **String** | Unknown | [optional] | |
76 | | -|**economyPauseStart** | **String** | Unknown | [optional] | |
77 | | -|**economyState** | **Integer** | Unknown | [optional] | |
| 80 | +|**economyLedgerBackfill** | **Boolean** | Unknown | | |
| 81 | +|**economyLedgerMigrationStop** | **String** | Unknown | | |
| 82 | +|**economyLedgerMode** | **String** | Unknown | | |
| 83 | +|**economyPauseEnd** | **OffsetDateTime** | Unknown | | |
| 84 | +|**economyPauseStart** | **OffsetDateTime** | Unknown | | |
| 85 | +|**economyPurchaseRepairEnabled** | **Boolean** | Unknown | | |
| 86 | +|**economyState** | **Integer** | Unknown | | |
78 | 87 | |**events** | [**APIConfigEvents**](APIConfigEvents.md) | | | |
79 | 88 | |**forceUseLatestWorld** | **Boolean** | Unknown | | |
80 | 89 | |**giftDisplayType** | **String** | Display type of gifts | | |
|
83 | 92 | |**homepageRedirectTarget** | **String** | Redirect target if you try to open the base API domain in your browser | | |
84 | 93 | |**hubWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | | |
85 | 94 | |**imageHostUrlList** | **List<String>** | A list of explicitly allowed origins that worlds can request images from via the Udon's [VRCImageDownloader#DownloadImage](https://creators.vrchat.com/worlds/udon/image-loading/#downloadimage). | | |
| 95 | +|**iosAppVersion** | **List<String>** | Current app version for iOS | | |
| 96 | +|**iosVersion** | [**APIConfigIosVersion**](APIConfigIosVersion.md) | | | |
86 | 97 | |**jobsEmail** | **String** | VRChat's job application email | | |
| 98 | +|**maxUserEmoji** | **Integer** | The maximum number of custom emoji each user may have at a given time. | | |
| 99 | +|**maxUserStickers** | **Integer** | The maximum number of custom stickers each user may have at a given time. | | |
87 | 100 | |**minSupportedClientBuildNumber** | [**APIConfigMinSupportedClientBuildNumber**](APIConfigMinSupportedClientBuildNumber.md) | | | |
88 | 101 | |**minimumUnityVersionForUploads** | **String** | Minimum Unity version required for uploading assets | | |
89 | 102 | |**moderationEmail** | **String** | VRChat's moderation related email | | |
90 | 103 | |**notAllowedToSelectAvatarInPrivateWorldMessage** | **String** | Used in-game to notify a user they aren't allowed to select avatars in private worlds | | |
91 | 104 | |**offlineAnalysis** | [**APIConfigOfflineAnalysis**](APIConfigOfflineAnalysis.md) | | | |
92 | 105 | |**photonNameserverOverrides** | **List<String>** | Unknown | | |
93 | 106 | |**photonPublicKeys** | **List<String>** | Unknown | | |
94 | | -|**reportCategories** | [**APIConfigReportCategories**](APIConfigReportCategories.md) | | | |
| 107 | +|**playerUrlResolverSha1** | **String** | Currently used youtube-dl.exe hash in SHA1-delimited format | | |
| 108 | +|**playerUrlResolverVersion** | **String** | Currently used youtube-dl.exe version | | |
| 109 | +|**publicKey** | **String** | Public key, hex encoded | | |
| 110 | +|**reportCategories** | [**Map<String, ReportCategory>**](ReportCategory.md) | Categories available for reporting objectionable content | | |
95 | 111 | |**reportFormUrl** | **String** | URL to the report form | | |
96 | | -|**reportOptions** | [**APIConfigReportOptions**](APIConfigReportOptions.md) | | | |
97 | | -|**reportReasons** | [**APIConfigReportReasons**](APIConfigReportReasons.md) | | | |
| 112 | +|**reportOptions** | **Map<String, Map<String, List<String>>>** | Options for reporting content. Select a key+value from this mapping as the `type` of the report. Select one key+value from the object at reportOptions[type] as the `category` of the report. reportCategories[category] contains user-facing text to display for all possible categories. Select one value from the array at reportOptions[type][category] as the `reason` of the report. reportReasons[reason] contains user-facing text to display for all possible categories. | | |
| 113 | +|**reportReasons** | [**Map<String, ReportReason>**](ReportReason.md) | Reasons available for submitting a report | | |
98 | 114 | |**requireAgeVerificationBetaTag** | **Boolean** | | | |
99 | 115 | |**sdkDeveloperFaqUrl** | **String** | Link to the developer FAQ | | |
100 | 116 | |**sdkDiscordUrl** | **String** | Link to the official VRChat Discord | | |
|
103 | 119 | |**stringHostUrlList** | **List<String>** | A list of explicitly allowed origins that worlds can request strings from via the Udon's [VRCStringDownloader.LoadUrl](https://creators.vrchat.com/worlds/udon/string-loading/#ivrcstringdownload). | | |
104 | 120 | |**supportEmail** | **String** | VRChat's support email | | |
105 | 121 | |**supportFormUrl** | **String** | VRChat's support form | | |
106 | | -|**timekeeping** | **Boolean** | Unknown | | |
107 | 122 | |**timeOutWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | | |
| 123 | +|**timekeeping** | **Boolean** | Unknown | | |
108 | 124 | |**tutorialWorldId** | **String** | WorldID be \"offline\" on User profiles if you are not friends with that user. | | |
109 | 125 | |**updateRateMsMaximum** | **Integer** | Unknown | | |
110 | 126 | |**updateRateMsMinimum** | **Integer** | Unknown | | |
|
114 | 130 | |**urlList** | **List<String>** | List of allowed URLs that bypass the \"Allow untrusted URL's\" setting in-game | | |
115 | 131 | |**useReliableUdpForVoice** | **Boolean** | Unknown | | |
116 | 132 | |**viveWindowsUrl** | **String** | Download link for game on the Steam website. | | |
117 | | -|**whiteListedAssetUrls** | **List<String>** | List of allowed URLs that are allowed to host avatar assets | | |
118 | | -|**playerUrlResolverVersion** | **String** | Currently used youtube-dl.exe version | | |
119 | | -|**playerUrlResolverSha1** | **String** | Currently used youtube-dl.exe hash in SHA1-delimited format | | |
120 | | -|**publicKey** | **String** | Public key, hex encoded | | |
121 | 133 | |**websocketMaxFriendsRefreshDelay** | **Integer** | Unknown | | |
122 | 134 | |**websocketQuickReconnectTime** | **Integer** | Unknown | | |
123 | 135 | |**websocketReconnectMaxDelay** | **Integer** | Unknown | | |
| 136 | +|**whiteListedAssetUrls** | **List<String>** | List of allowed URLs that are allowed to host avatar assets | | |
124 | 137 |
|
125 | 138 |
|
126 | 139 |
|
0 commit comments