mirror of
https://github.com/signalapp/Signal-Server
synced 2026-10-07 23:29:26 +01:00
Updating documentation
This commit is contained in:
Documentation Updater committed
1 parent
05018238b2
commit
f648ed8311
4 files changed
+1328
-6
No files matched your search
File diff suppressed because it is too large.
Load diff
@@ -311,6 +311,24 @@
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
<a href="#message-org.signal.chat.profile.SetV1AvatarRequest">
|
||||
<span class="tag" style="min-width: 6em">Message</span>
|
||||
<code>SetV1AvatarRequest</code>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
<a href="#message-org.signal.chat.profile.SetV1AvatarResponse">
|
||||
<span class="tag" style="min-width: 6em">Message</span>
|
||||
<code>SetV1AvatarResponse</code>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
@@ -414,6 +432,32 @@ should use the version of this method in <code>ProfileAnonymous</code> instead.<
|
||||
<p>Note: <code>Accounts.SetZkCredentialKey</code> is a pre-requisite for this RPC</p></p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="box">
|
||||
<div class="block">
|
||||
<h5 class="title is-5" id="service-org.signal.chat.profile.Profile-SetV1Avatar">
|
||||
<a href="#service-org.signal.chat.profile.Profile-SetV1Avatar">
|
||||
rpc <code>SetV1Avatar</code>
|
||||
</a>
|
||||
</h5>
|
||||
Request: <code><a href="org.signal.chat.profile.html#message-org.signal.chat.profile.SetV1AvatarRequest"><span title="org.signal.chat.profile.SetV1AvatarRequest">org.signal.chat.profile.SetV1AvatarRequest</span>
|
||||
</a></code><br>
|
||||
Response: <code><a href="org.signal.chat.profile.html#message-org.signal.chat.profile.SetV1AvatarResponse"><span title="org.signal.chat.profile.SetV1AvatarResponse">org.signal.chat.profile.SetV1AvatarResponse</span>
|
||||
</a></code><br>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="block">
|
||||
<p><p>Returns credentials used by clients to upload a v1 avatar, deleting any current avatar.</p>
|
||||
<p>This RPC streamlines avatar changes during the v1 -> v2 transition by minimizing uploads:
|
||||
1. SetV1Avatar
|
||||
2. Upload to CDN
|
||||
3. SetProfile with v1 <code>AVATAR_CHANGE_UNCHANGED</code> and the v1 avatar in the v2 profile body</p>
|
||||
<p>Clients that do this will be required to upload current avatars using <code>ProfilesAnonymous.GetAvatarUploadFormRequest</code>
|
||||
once v1 Profile APIs are no longer supported.</p></p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -1200,7 +1244,7 @@ performed with this form will be limited to the provided length.</p></td>
|
||||
</a>
|
||||
</code>
|
||||
</td>
|
||||
<td class="content"></td>
|
||||
<td class="content"><p>the policy and credential used by clients to upload an avatar to the CDN</p></td>
|
||||
|
||||
</tr>
|
||||
|
||||
@@ -2821,6 +2865,122 @@ field number without serialization overhead. This is purely aesthetic.</p></td>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="block">
|
||||
|
||||
|
||||
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.SetV1AvatarRequest">
|
||||
<span>
|
||||
<a href="#message-org.signal.chat.profile.SetV1AvatarRequest" title="org.signal.chat.profile.SetV1AvatarRequest">message SetV1AvatarRequest</a>
|
||||
|
||||
</span>
|
||||
|
||||
</h4>
|
||||
|
||||
<div class="block content">
|
||||
|
||||
</div>
|
||||
|
||||
<table class="table is-fullwidth is-hoverable is-bordered">
|
||||
<thead>
|
||||
<tr>
|
||||
<th></th>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr>
|
||||
<td>1</td>
|
||||
<td>
|
||||
version
|
||||
</td>
|
||||
<td>
|
||||
<code title="string">
|
||||
|
||||
<span>string</span>
|
||||
</code>
|
||||
</td>
|
||||
<td class="content"><p>The profile version. Required.</p></td>
|
||||
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>2</td>
|
||||
<td>
|
||||
commitment
|
||||
</td>
|
||||
<td>
|
||||
<code title="bytes">
|
||||
|
||||
<span>bytes</span>
|
||||
</code>
|
||||
</td>
|
||||
<td class="content"><p>The profile key commitment. Required if this is a new profile version.</p></td>
|
||||
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="block">
|
||||
|
||||
|
||||
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.SetV1AvatarResponse">
|
||||
<span>
|
||||
<a href="#message-org.signal.chat.profile.SetV1AvatarResponse" title="org.signal.chat.profile.SetV1AvatarResponse">message SetV1AvatarResponse</a>
|
||||
|
||||
</span>
|
||||
|
||||
</h4>
|
||||
|
||||
<div class="block content">
|
||||
|
||||
</div>
|
||||
|
||||
<table class="table is-fullwidth is-hoverable is-bordered">
|
||||
<thead>
|
||||
<tr>
|
||||
<th></th>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr>
|
||||
<td>1</td>
|
||||
<td>
|
||||
form
|
||||
</td>
|
||||
<td>
|
||||
<code title="org.signal.chat.common.S3UploadForm">
|
||||
|
||||
<a href="org.signal.chat.common.html#message-org.signal.chat.common.S3UploadForm"><span title="org.signal.chat.common.S3UploadForm">org.signal.chat.common.S3UploadForm</span>
|
||||
</a>
|
||||
</code>
|
||||
</td>
|
||||
<td class="content"><p>the policy and credential used by clients to upload an avatar to the CDN</p></td>
|
||||
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
+2
-2
@@ -60,8 +60,8 @@
|
||||
|
||||
<div id="main-content" class="container mb-6">
|
||||
<script>
|
||||
const searchDocuments = {"org.signal.chat.account": {"package": "org.signal.chat.account", "url": "org.signal.chat.account.html", "content": "org.signal.chat.account\n\norg\nsignal\nchat\naccount\nAccounts\nProvides methods for working with Signal accounts.\nGetAccountIdentity\nReturns basic identifiers for the authenticated account.\norg\nsignal\nchat\naccount\nGetAccountIdentityRequest\norg\nsignal\nchat\naccount\nGetAccountIdentityResponse\nGetEntitlements\nReturns entitlements for the authenticated account.\norg\nsignal\nchat\naccount\nGetEntitlementsRequest\norg\nsignal\nchat\naccount\nGetEntitlementsResponse\nDeleteAccount\nDeletes the authenticated account, purging all associated data in the\n process.\norg\nsignal\nchat\naccount\nDeleteAccountRequest\norg\nsignal\nchat\naccount\nDeleteAccountResponse\nSetRegistrationLock\nSets the registration lock secret for the authenticated account. To remove\n a registration lock, please use `ClearRegistrationLock`.\norg\nsignal\nchat\naccount\nSetRegistrationLockRequest\norg\nsignal\nchat\naccount\nSetRegistrationLockResponse\nClearRegistrationLock\nRemoves any registration lock credentials from the authenticated account.\norg\nsignal\nchat\naccount\nClearRegistrationLockRequest\norg\nsignal\nchat\naccount\nClearRegistrationLockResponse\nReserveUsernameHash\nAttempts to reserve one of multiple given username hashes. Reserved\n usernames may be claimed later via `ConfirmUsernameHash`.\norg\nsignal\nchat\naccount\nReserveUsernameHashRequest\norg\nsignal\nchat\naccount\nReserveUsernameHashResponse\nConfirmUsernameHash\nSets the username hash/encrypted username to a previously-reserved value\n (see `ReserveUsernameHash`).\norg\nsignal\nchat\naccount\nConfirmUsernameHashRequest\norg\nsignal\nchat\naccount\nConfirmUsernameHashResponse\nDeleteUsernameHash\nClears the current username hash, ciphertext, and link for the\n authenticated user.\norg\nsignal\nchat\naccount\nDeleteUsernameHashRequest\norg\nsignal\nchat\naccount\nDeleteUsernameHashResponse\nSetUsernameLink\nAssociates the given username ciphertext with the account, replacing any\n previously stored ciphertext. A new link handle will optionally be created,\n and the link handle to use will be returned in any event.\norg\nsignal\nchat\naccount\nSetUsernameLinkRequest\norg\nsignal\nchat\naccount\nSetUsernameLinkResponse\nDeleteUsernameLink\nClears any username link associated with the authenticated account.\norg\nsignal\nchat\naccount\nDeleteUsernameLinkRequest\norg\nsignal\nchat\naccount\nDeleteUsernameLinkResponse\nConfigureUnidentifiedAccess\nConfigures \"unidentified access\" keys and preferences for the authenticated\n account. Other users permitted to interact with this account anonymously\n may take actions like fetching pre-keys and profiles for this account or\n sending sealed-sender messages without providing identifying credentials.\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessRequest\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessResponse\nSetDiscoverableByPhoneNumber\nSets whether the authenticated account may be discovered by phone number\n via the Contact Discovery Service (CDS).\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberRequest\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberResponse\nSetRegistrationRecoveryPassword\nSets the registration recovery password for the authenticated account.\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordRequest\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordResponse\nSetZkCredentialKey\nStore a public key used to issue and verify zero-knowledge (anonymous) credentials for the account.\norg\nsignal\nchat\naccount\nSetZkCredentialKeyRequest\norg\nsignal\nchat\naccount\nSetZkCredentialKeyResponse\nChangeNumber\nChanges the phone number associated with the authenticated account.\norg\nsignal\nchat\naccount\nChangeNumberRequest\norg\nsignal\nchat\naccount\nChangeNumberResponse\nGetAccountDataReport\nProduces a report of non-ephemeral account data stored by the service\norg\nsignal\nchat\naccount\nGetAccountDataReportRequest\norg\nsignal\nchat\naccount\nGetAccountDataReportResponse\nGetCapabilities\nGets the capabilities for the authenticated account.\norg\nsignal\nchat\naccount\nGetCapabilitiesRequest\norg\nsignal\nchat\naccount\nGetCapabilitiesResponse\norg\nsignal\nchat\naccount\nAccountsAnonymous\nProvides methods for looking up Signal accounts. Callers must not provide\n identifying credentials when calling methods in this service.\nCheckAccountExistence\nChecks whether an account with the given service identifier exists.\norg\nsignal\nchat\naccount\nCheckAccountExistenceRequest\norg\nsignal\nchat\naccount\nCheckAccountExistenceResponse\nLookupUsernameHash\nFinds the service identifier of the account associated with the given\n username hash.\norg\nsignal\nchat\naccount\nLookupUsernameHashRequest\norg\nsignal\nchat\naccount\nLookupUsernameHashResponse\nLookupUsernameLink\nFinds the encrypted uLine truncated
|
||||
const searchIndex = {"version": "2.3.9", "fields": ["content", "url"], "fieldVectors": [["content/org.signal.chat.account", [0, 1.616, 1, 0.167, 2, 0.167, 3, 0.167, 4, 1.198, 5, 0.362, 6, 0.769, 7, 0.701, 8, 1.616, 9, 0.869, 10, 1.616, 11, 1.576, 12, 1.265, 13, 2.517, 14, 2.517, 15, 1.616, 16, 2.483, 17, 2.517, 18, 3.492, 19, 1.616, 20, 0.93, 21, 1.616, 22, 1.132, 23, 2.011, 24, 1.087, 25, 2.517, 26, 2.517, 27, 1.616, 28, 0.951, 29, 2.507, 30, 3.572, 31, 2.35, 32, 1.45, 33, 1.616, 34, 0.52, 35, 2.517, 36, 2.517, 37, 2.517, 38, 1.152, 39, 2.517, 40, 2.517, 41, 2.517, 42, 2.021, 43, 4.187, 44, 1.022, 45, 1.087, 46, 1.931, 47, 2.638, 48, 2.378, 49, 3.093, 50, 1.297, 51, 1.25, 52, 2.517, 53, 2.517, 54, 2.517, 55, 1.616, 56, 1.255, 57, 0.997, 58, 1.087, 59, 2.517, 60, 3.093, 61, 1.616, 62, 2.483, 63, 1.092, 64, 2.817, 65, 2.135, 66, 1.518, 67, 2.517, 68, 2.517, 69, 1.616, 70, 1.087, 71, 2.011, 72, 1.265, 73, 3.167, 74, 0.701, 75, 1.255, 76, 1.616, 77, 2.517, 78, 2.517, 79, 1.616, 80, 2.517, 81, 2.517, 82, 1.616, 83, 1.542, 84, 2.411, 85, 1.585, 86, 1.283, 87, 1.297, 88, 1.45, 89, 2.803, 90, 1.642, 91, 1.616, 92, 1.297, 93, 1.087, 94, 1.74, 95, 1.694, 96, 1.879, 97, 0.805, 98, 0.805, 99, 1.088, 100, 1.255, 101, 2.517, 102, 2.517, 103, 1.616, 104, 1.171, 105, 3.093, 106, 2.346, 107, 1.651, 108, 2.517, 109, 2.517, 110, 1.555, 111, 2.517, 112, 2.517, 113, 2.517, 114, 1.616, 115, 2.483, 116, 2.18, 117, 2.517, 118, 2.517, 119, 1.616, 120, 1.781, 121, 0.701, 122, 1.45, 123, 2.081, 124, 2.021, 125, 2.517, 126, 2.517, 127, 1.616, 128, 0.953, 129, 3.785, 130, 2.517, 131, 1.616, 132, 1.297, 133, 3.093, 134, 1.45, 135, 1.297, 136, 2.517, 137, 2.517, 138, 2.517, 139, 1.694, 140, 3.652, 141, 2.517, 142, 2.517, 143, 1.616, 144, 1.297, 145, 0.701, 146, 1.022, 147, 0.464, 148, 1.616, 149, 0.805, 150, 1.998, 151, 2.517, 152, 2.517, 153, 1.616, 154, 3.492, 155, 2.517, 156, 2.517, 157, 1.616, 158, 1.342, 159, 2.517, 160, 2.517, 161, 1.616, 162, 2.483, 163, 2.35, 164, 1.45, 165, 2.517, 166, 2.517, 167, 1.616, 168, 2.081, 169, 2.35, 170, 2.517, 171, 1.342, 172, 0.953, 173, 0.832, 174, 1.616, 175, 1.087, 176, 0.841, 177, 1.817, 178, 0.93, 179, 0.93, 180, 0.93, 181, 1.297, 182, 0.93, 183, 1.087, 184, 1.152, 185, 1.616, 186, 2.35, 187, 1.616, 188, 2.517, 189, 1.616, 190, 1.383, 191, 0.93, 192, 1.616, 193, 1.297, 194, 2.517, 195, 2.182, 196, 1.694, 197, 1.087, 198, 1.297, 199, 1.998, 200, 0.93, 201, 1.087, 202, 1.616, 203, 1.694, 204, 1.087, 205, 1.004, 206, 2.517, 207, 1.255, 208, 1.45, 209, 0.634, 210, 1.616, 211, 1.297, 212, 1.616, 213, 0.93, 214, 1.297, 215, 1.616, 216, 2.483, 217, 0.464, 218, 1.297, 219, 2.021, 220, 2.517, 221, 1.616, 222, 1.297, 223, 1.297, 224, 2.021, 225, 1.616, 226, 0.93, 227, 1.616, 228, 1.616, 229, 1.616, 230, 1.616, 231, 0.701, 232, 0.612, 233, 1.616, 234, 1.694, 235, 1.616, 236, 1.342, 237, 1.087, 238, 1.171, 239, 1.781, 240, 1.45, 241, 0.534, 242, 1.297, 243, 2.081, 244, 0.746, 245, 1.45, 246, 1.616, 247, 2.081, 248, 2.803, 249, 1.616, 250, 1.297, 251, 0.869, 252, 1.297, 253, 3.093, 254, 1.297, 255, 1.616, 256, 1.297, 257, 1.297, 258, 1.616, 259, 1.297, 260, 1.616, 261, 0.805, 262, 0.701, 263, 2.021, 264, 1.616, 265, 2.517, 266, 1.616, 267, 0.805, 268, 1.616, 269, 2.483, 270, 0.538, 271, 1.297, 272, 1.616, 273, 1.616, 274, 1.616, 275, 2.021, 276, 2.021, 277, 3.093, 278, 1.616, 279, 1.087, 280, 1.092, 281, 0.93, 282, 0.701, 283, 0.93, 284, 0.534, 285, 2.483, 286, 0.93, 287, 1.092, 288, 1.297, 289, 1.297, 290, 1.616, 291, 1.297, 292, 1.092, 293, 1.616, 294, 1.297, 295, 1.616, 296, 1.616, 297, 1.616, 298, 0.402, 299, 1.087, 300, 0.93, 301, 0.612, 302, 1.616, 303, 1.616, 304, 1.616, 305, 0.805, 306, 1.694, 307, 0.93, 308, 0.402, 309, 1.616, 310, 1.616, 311, 0.93, 312, 1.616, 313, 1.087, 314, 1.616, 315, 1.616, 316, 0.93, 317, 1.087, 318, 1.616, 319, 1.087, 320, 0.612, 321, 0.93, 322, 1.616, 323, 1.616, 324, 1.616, 325, 1.297, 326, 1.45, 327, 1.616, 328, 1.616, 329, 1.087, 330, 1.616, 331, 1.616, 332, 0.93, 333, 1.616]], ["url/org.signal.chat.account", [334, 2.59]], ["content/org.signal.chat.attachments", [1, 0.163, 2, 0.163, 3, 0.163, 5, 0.283, 34, 0.607, 72, 0.946, 107, 1.257, 128, 1.441, 176, 0.69, 209, 0.828, 241, 1.507, 251, 0.946, 335, 3.805, 336, 3.14, 337, 3.054, 338, 2.727, 339, 3.03, 340, 3.07, 341, 2.56, 342, 3.663, 343, 3.663, 344, 3.805, 345, 5.32, 346, 5.183, 347, 4.563, 348, 4.563, 349, 3.805, 350, 3.805, 351, 3.805, 352, 3.805, 353, 0.946, 354, 3.805, 355, 3.805, 356, 3.054, 357, 1.896, 358, 3.054, 359, 3.07, 360, 1.896, 361, 3.054, 362, 3.054, 363, 2.815, 364, 3.054, 365, 2.628, 366, 1.896, 367, 3.054, 368, 3.054, 369, 3.054]], ["url/org.signal.chat.attachments", [370, 2.59]], ["content/org.signal.chat.backup", [1, 0.165, 2, 0.165, 3, 0.165, 4, 0.977, 5, 0.369, 9, 0.996, 12, 1.227, 20, 2.062, 22, 1.117, 23, 1.652, 28, 1.017, 31, 0.968, 32, 1.323, 34, 0.603, 38, 1.522, 44, 0.759, 47, 1.145, 51, 1.183, 56, 1.902, 57, 0.815, 63, 1.245, 65, 0.997, 71, 2.893, 72, 0.358, 85, 0.545, 86, 1.313, 89,Line truncated
|
||||
const searchDocuments = {"org.signal.chat.account": {"package": "org.signal.chat.account", "url": "org.signal.chat.account.html", "content": "org.signal.chat.account\n\norg\nsignal\nchat\naccount\nAccounts\nProvides methods for working with Signal accounts.\nGetAccountIdentity\nReturns basic identifiers for the authenticated account.\norg\nsignal\nchat\naccount\nGetAccountIdentityRequest\norg\nsignal\nchat\naccount\nGetAccountIdentityResponse\nGetEntitlements\nReturns entitlements for the authenticated account.\norg\nsignal\nchat\naccount\nGetEntitlementsRequest\norg\nsignal\nchat\naccount\nGetEntitlementsResponse\nDeleteAccount\nDeletes the authenticated account, purging all associated data in the\n process.\norg\nsignal\nchat\naccount\nDeleteAccountRequest\norg\nsignal\nchat\naccount\nDeleteAccountResponse\nSetRegistrationLock\nSets the registration lock secret for the authenticated account. To remove\n a registration lock, please use `ClearRegistrationLock`.\norg\nsignal\nchat\naccount\nSetRegistrationLockRequest\norg\nsignal\nchat\naccount\nSetRegistrationLockResponse\nClearRegistrationLock\nRemoves any registration lock credentials from the authenticated account.\norg\nsignal\nchat\naccount\nClearRegistrationLockRequest\norg\nsignal\nchat\naccount\nClearRegistrationLockResponse\nReserveUsernameHash\nAttempts to reserve one of multiple given username hashes. Reserved\n usernames may be claimed later via `ConfirmUsernameHash`.\norg\nsignal\nchat\naccount\nReserveUsernameHashRequest\norg\nsignal\nchat\naccount\nReserveUsernameHashResponse\nConfirmUsernameHash\nSets the username hash/encrypted username to a previously-reserved value\n (see `ReserveUsernameHash`).\norg\nsignal\nchat\naccount\nConfirmUsernameHashRequest\norg\nsignal\nchat\naccount\nConfirmUsernameHashResponse\nDeleteUsernameHash\nClears the current username hash, ciphertext, and link for the\n authenticated user.\norg\nsignal\nchat\naccount\nDeleteUsernameHashRequest\norg\nsignal\nchat\naccount\nDeleteUsernameHashResponse\nSetUsernameLink\nAssociates the given username ciphertext with the account, replacing any\n previously stored ciphertext. A new link handle will optionally be created,\n and the link handle to use will be returned in any event.\norg\nsignal\nchat\naccount\nSetUsernameLinkRequest\norg\nsignal\nchat\naccount\nSetUsernameLinkResponse\nDeleteUsernameLink\nClears any username link associated with the authenticated account.\norg\nsignal\nchat\naccount\nDeleteUsernameLinkRequest\norg\nsignal\nchat\naccount\nDeleteUsernameLinkResponse\nConfigureUnidentifiedAccess\nConfigures \"unidentified access\" keys and preferences for the authenticated\n account. Other users permitted to interact with this account anonymously\n may take actions like fetching pre-keys and profiles for this account or\n sending sealed-sender messages without providing identifying credentials.\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessRequest\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessResponse\nSetDiscoverableByPhoneNumber\nSets whether the authenticated account may be discovered by phone number\n via the Contact Discovery Service (CDS).\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberRequest\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberResponse\nSetRegistrationRecoveryPassword\nSets the registration recovery password for the authenticated account.\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordRequest\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordResponse\nSetZkCredentialKey\nStore a public key used to issue and verify zero-knowledge (anonymous) credentials for the account.\norg\nsignal\nchat\naccount\nSetZkCredentialKeyRequest\norg\nsignal\nchat\naccount\nSetZkCredentialKeyResponse\nChangeNumber\nChanges the phone number associated with the authenticated account.\norg\nsignal\nchat\naccount\nChangeNumberRequest\norg\nsignal\nchat\naccount\nChangeNumberResponse\nGetAccountDataReport\nProduces a report of non-ephemeral account data stored by the service\norg\nsignal\nchat\naccount\nGetAccountDataReportRequest\norg\nsignal\nchat\naccount\nGetAccountDataReportResponse\nGetCapabilities\nGets the capabilities for the authenticated account.\norg\nsignal\nchat\naccount\nGetCapabilitiesRequest\norg\nsignal\nchat\naccount\nGetCapabilitiesResponse\nGenerateTotpKey\nGenerates and stores a pending TOTP key for the authenticated account.\n To \"activate\" the key, callers must call the `ConfirmTotpKey` endpoint.\norg\nsignal\nchat\naccount\nGenerateTotpKeyRequest\norg\nsignal\nchat\naccount\nGenerateTotpKeyResponse\nConfirmTotpKey\nConfirms that the caller has stored and can derive one-time passwords from\n a pending TOTP key generated via `GenerateTotpKey` and stores/activates the\n key for the caller's account\norg\nsignal\nchat\naccount\nConfirmTotpKeyRequest\norg\nsignal\nchat\naccount\nConfirmTotpKeyResponse\nListTotpKeys\nReturns a list of confirmed TOTP keys for the authenticated accountLine truncated
|
||||
const searchIndex = {"version": "2.3.9", "fields": ["content", "url"], "fieldVectors": [["content/org.signal.chat.account", [0, 1.421, 1, 0.167, 2, 0.168, 3, 0.167, 4, 1.198, 5, 0.37, 6, 0.708, 7, 0.617, 8, 1.421, 9, 0.885, 10, 1.421, 11, 1.613, 12, 1.27, 13, 2.275, 14, 2.275, 15, 1.421, 16, 2.284, 17, 2.275, 18, 3.252, 19, 1.421, 20, 0.818, 21, 1.421, 22, 1.151, 23, 1.873, 24, 0.956, 25, 2.275, 26, 2.275, 27, 1.421, 28, 0.912, 29, 2.452, 30, 3.428, 31, 2.188, 32, 2.048, 33, 1.421, 34, 0.53, 35, 2.275, 36, 2.275, 37, 2.275, 38, 1.091, 39, 2.275, 40, 2.275, 41, 2.275, 42, 1.826, 43, 3.985, 44, 1.411, 45, 0.956, 46, 1.901, 47, 2.603, 48, 2.306, 49, 2.845, 50, 1.141, 51, 1.254, 52, 2.275, 53, 2.275, 54, 2.275, 55, 1.421, 56, 1.134, 57, 0.991, 58, 0.956, 59, 2.275, 60, 2.845, 61, 1.421, 62, 2.284, 63, 1.234, 64, 3.011, 65, 2.081, 66, 1.659, 67, 2.275, 68, 2.275, 69, 1.421, 70, 0.956, 71, 2.384, 72, 1.26, 73, 3.066, 74, 0.617, 75, 1.134, 76, 1.421, 77, 2.275, 78, 2.275, 79, 1.421, 80, 2.275, 81, 2.275, 82, 1.421, 83, 1.418, 84, 2.295, 85, 1.509, 86, 1.332, 87, 1.141, 88, 1.31, 89, 2.61, 90, 1.543, 91, 1.421, 92, 1.141, 93, 0.956, 94, 1.621, 95, 1.531, 96, 1.797, 97, 0.708, 98, 0.708, 99, 1.022, 100, 1.134, 101, 2.275, 102, 2.275, 103, 1.421, 104, 1.077, 105, 2.845, 106, 2.271, 107, 1.613, 108, 2.275, 109, 2.275, 110, 1.505, 111, 2.275, 112, 2.275, 113, 2.275, 114, 1.421, 115, 2.284, 116, 2.577, 117, 2.275, 118, 2.275, 119, 1.421, 120, 1.638, 121, 0.617, 122, 1.31, 123, 1.914, 124, 1.826, 125, 2.275, 126, 2.275, 127, 1.421, 128, 0.861, 129, 3.557, 130, 2.275, 131, 1.421, 132, 1.826, 133, 2.845, 134, 1.31, 135, 1.141, 136, 2.275, 137, 2.275, 138, 2.275, 139, 1.531, 140, 3.516, 141, 2.275, 142, 2.275, 143, 2.275, 144, 1.113, 145, 2.856, 146, 4.984, 147, 1.234, 148, 1.254, 149, 0.654, 150, 2.275, 151, 0.708, 152, 2.275, 153, 2.845, 154, 3.199, 155, 1.531, 156, 0.991, 157, 1.421, 158, 0.538, 159, 2.275, 160, 2.845, 161, 1.421, 162, 1.145, 163, 2.275, 164, 3.252, 165, 1.421, 166, 0.617, 167, 1.411, 168, 1.914, 169, 2.185, 170, 2.284, 171, 1.531, 172, 1.531, 173, 1.418, 174, 2.275, 175, 1.134, 176, 1.986, 177, 2.275, 178, 2.845, 179, 1.421, 180, 2.275, 181, 2.275, 182, 1.421, 183, 1.141, 184, 0.617, 185, 1.421, 186, 0.708, 187, 2.275, 188, 2.275, 189, 1.421, 190, 3.252, 191, 2.275, 192, 2.275, 193, 1.421, 194, 2.275, 195, 2.275, 196, 1.421, 197, 2.284, 198, 2.188, 199, 1.31, 200, 2.275, 201, 2.275, 202, 1.421, 203, 1.914, 204, 2.188, 205, 2.275, 206, 1.234, 207, 1.077, 208, 0.751, 209, 1.421, 210, 0.956, 211, 0.827, 212, 1.729, 213, 0.818, 214, 0.818, 215, 1.141, 216, 0.818, 217, 0.956, 218, 1.421, 219, 2.188, 220, 1.421, 221, 2.275, 222, 1.421, 223, 1.316, 224, 0.818, 225, 1.421, 226, 1.141, 227, 2.275, 228, 2.134, 229, 0.956, 230, 1.141, 231, 1.891, 232, 0.818, 233, 0.956, 234, 1.421, 235, 1.531, 236, 0.956, 237, 1.091, 238, 2.275, 239, 1.418, 240, 1.31, 241, 0.59, 242, 1.421, 243, 1.141, 244, 1.421, 245, 0.818, 246, 1.141, 247, 1.421, 248, 2.284, 249, 0.408, 250, 1.141, 251, 1.826, 252, 2.275, 253, 1.421, 254, 1.826, 255, 1.826, 256, 1.826, 257, 1.421, 258, 1.31, 259, 1.421, 260, 1.421, 261, 1.421, 262, 1.421, 263, 0.617, 264, 0.538, 265, 1.421, 266, 1.531, 267, 1.421, 268, 1.234, 269, 0.956, 270, 1.231, 271, 1.638, 272, 1.31, 273, 0.469, 274, 1.141, 275, 1.914, 276, 0.695, 277, 1.31, 278, 1.421, 279, 1.914, 280, 1.421, 281, 2.845, 282, 1.421, 283, 1.134, 284, 2.284, 285, 1.421, 286, 0.956, 287, 1.421, 288, 0.708, 289, 1.421, 290, 1.421, 291, 1.141, 292, 2.61, 293, 1.421, 294, 1.141, 295, 2.284, 296, 2.845, 297, 1.141, 298, 1.421, 299, 1.141, 300, 1.421, 301, 1.141, 302, 1.421, 303, 0.708, 304, 0.617, 305, 1.421, 306, 2.275, 307, 1.421, 308, 0.708, 309, 1.421, 310, 2.284, 311, 0.486, 312, 1.421, 313, 1.421, 314, 1.421, 315, 1.826, 316, 1.421, 317, 2.284, 318, 1.421, 319, 1.31, 320, 1.421, 321, 0.861, 322, 1.826, 323, 2.845, 324, 1.421, 325, 0.956, 326, 0.987, 327, 0.818, 328, 0.617, 329, 0.818, 330, 0.469, 331, 2.284, 332, 0.818, 333, 1.141, 334, 1.421, 335, 1.421, 336, 2.284, 337, 1.638, 338, 1.421, 339, 1.421, 340, 2.275, 341, 1.531, 342, 1.421, 343, 1.141, 344, 0.987, 345, 1.421, 346, 1.141, 347, 1.421, 348, 1.421, 349, 1.421, 350, 1.421, 351, 0.956, 352, 0.818, 353, 1.421, 354, 1.421, 355, 1.421, 356, 0.708, 357, 1.531, 358, 0.818, 359, 0.354, 360, 1.421, 361, 1.421, 362, 0.818, 363, 1.421, 364, 0.956, 365, 1.421, 366, 1.141, 367, 1.421, 368, 1.421, 369, 1.421, 370, 0.956, 371, 1.421, 372, 0.956, 373, 0.538, 374, 0.818, 375, 1.421, 376, 1.421, 377, 1.421, 378, 1.141, 379, 1.31, 380, 1.421, 381, 1.421, 382, 0.956, 383, 1.421, 384, 1.421, 385, 0.708, 386, 1.421, 387, 1.421, 388, 1.421, 389, 1.421, 390, 1.421, 391, 0.818, 392, 1.421, 393, 1.141, 394, 0.818, 395, 1.421, 396, 1.421, 397, 1.421]], ["url/org.signal.chat.account", [398, 2.59]], ["content/org.signal.chat.attachments", [1, 0.163, 2, 0.163, 3, 0.163, 5, 0.284, 34, 0.608, 72, 0.952, 107, 1.264, 128, 1.449, 144, 0.952, 211, 0.694, 241, 0.831, 273, 1.512Line truncated
|
||||
|
||||
const idx = lunr.Index.load(searchIndex);
|
||||
|
||||
|
||||
@@ -3160,6 +3160,9 @@ paths:
|
||||
description: "If present, an positive integer indicating the number\
|
||||
\ of seconds before a subsequent attempt could succeed"
|
||||
style: simple
|
||||
"441":
|
||||
description: "A valid one-time password (TOTP) is required, but either no\
|
||||
\ password was provided or it was incorrect"
|
||||
"499":
|
||||
description: Client must support post-quantum ratchet
|
||||
/v2/config:
|
||||
@@ -5856,12 +5859,12 @@ components:
|
||||
DonationPermit:
|
||||
type: object
|
||||
properties:
|
||||
spendId:
|
||||
type: string
|
||||
format: byte
|
||||
expiration:
|
||||
type: string
|
||||
format: date-time
|
||||
spendId:
|
||||
type: string
|
||||
format: byte
|
||||
internalContentsForJNI:
|
||||
type: string
|
||||
format: byte
|
||||
@@ -6377,6 +6380,12 @@ components:
|
||||
must not be provided if `sessionId` or `recoveryPassword` is provided.
|
||||
format: byte
|
||||
nullable: true
|
||||
totp:
|
||||
type: integer
|
||||
description: |
|
||||
A TOTP one-time password; required if recovering an account that has TOTP keys.
|
||||
format: int32
|
||||
nullable: true
|
||||
accountAttributes:
|
||||
$ref: "#/components/schemas/AccountAttributes"
|
||||
skipDeviceTransfer:
|
||||
|
||||
Reference in new issue
Block a user