signalapp/Signal-Server
signalapp/Signal-Server
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Updating documentation

Browse Source
This commit is contained in:
Documentation Updater 2026-06-18 15:07:21 +00:00
parent 8309273cdb
commit 4d57da79ac
9 changed files with 5452 additions and 572 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
grpc/index.html
View File

@ -121,6 +121,11 @@ header. If provided, the request will fail with a <code>BAD_AUTHENTICATION</code
<td style="text-align: left;">A server-side resource was exhausted. The <code>details</code> field may include a <a href="https://github.com/googleapis/googleapis/blob/8c06c1e04ae562f49f411357577c700e9142f33c/google/rpc/error_details.proto#L92"><code>RetryInfo</code> message</a> that includes the amount of time in seconds the client should wait before retrying the request. <br><br> If a <code>RetryInfo</code> is present, the client must wait the indicated time before retrying the request. If absent, the client should retry with an exponential backoff.</td>
</tr>
<tr>
<td style="text-align: left;"><code>ABORTED</code></td>
<td style="text-align: left;"><code>STREAM_CLOSED</code></td>
<td style="text-align: left;">The server terminated a streaming RPC for some domain specific reason. The <code>details</code> field must include a message with additional information about why the stream was closed. This message must be defined in the corresponding service proto for the streaming RPC. This status must only be returned from server-side streaming RPCs. Clients must handle a STREAM_CLOSED status even if no corresponding message is defined in the version of the proto they are targeting. Unless otherwise noted, if a stream termination message is defined, clients must handle the error at any point in the message stream.</td>
</tr>
<tr>
<td style="text-align: left;"><code>UNAVAILABLE</code></td>
<td style="text-align: left;"><code>UNAVAILABLE</code></td>
<td style="text-align: left;">There was an internal error processing the RPC. The client should retry the request with exponential backoff.</td>
@ -249,6 +254,13 @@ header. If provided, the request will fail with a <code>BAD_AUTHENTICATION</code
</h4>
<h4 class="title is-5">
<a href="org.signal.chat.subscriptions.html">org.signal.chat.subscriptions</a>
</h4>
<h4 class="title is-5">
<a href="org.signal.chat.tag.html">org.signal.chat.tag</a>

172
grpc/org.signal.chat.attachments.html
View File

@ -80,6 +80,24 @@
<p>
<a href="#message-org.signal.chat.attachments.GetStickerUploadFormRequest">
<span class="tag" style="min-width: 6em">Message</span>
<code>GetStickerUploadFormRequest</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.attachments.GetStickerUploadFormResponse">
<span class="tag" style="min-width: 6em">Message</span>
<code>GetStickerUploadFormResponse</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.attachments.GetUploadFormRequest">
<span class="tag" style="min-width: 6em">Message</span>
@ -144,6 +162,26 @@
<p><p>Retrieve an upload form that can be used to perform a resumable upload</p></p>
</div>
</div>
<div class="box">
<div class="block">
<h5 class="title is-5" id="service-org.signal.chat.attachments.Attachments-GetStickerUploadForm">
<a href="#service-org.signal.chat.attachments.Attachments-GetStickerUploadForm">
rpc <code>GetStickerUploadForm</code>
</a>
</h5>
Request: <code><a href="org.signal.chat.attachments.html#message-org.signal.chat.attachments.GetStickerUploadFormRequest"><span title="org.signal.chat.attachments.GetStickerUploadFormRequest">org.signal.chat.attachments.GetStickerUploadFormRequest</span>
</a></code><br>
Response: <code><a href="org.signal.chat.attachments.html#message-org.signal.chat.attachments.GetStickerUploadFormResponse"><span title="org.signal.chat.attachments.GetStickerUploadFormResponse">org.signal.chat.attachments.GetStickerUploadFormResponse</span>
</a></code><br>
</div>
<div class="block">
<p><p>Retrieve an upload form that can be used to upload a sticker pack</p></p>
</div>
</div>
</div>
@ -160,6 +198,140 @@
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.attachments.GetStickerUploadFormRequest">
<span>
<a href="#message-org.signal.chat.attachments.GetStickerUploadFormRequest" title="org.signal.chat.attachments.GetStickerUploadFormRequest">message GetStickerUploadFormRequest</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>
sticker_count
</td>
<td>
<code title="uint32">
<span>uint32</span>
</code>
</td>
<td class="content"><p>The number of stickers in the sticker pack to upload</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.attachments.GetStickerUploadFormResponse">
<span>
<a href="#message-org.signal.chat.attachments.GetStickerUploadFormResponse" title="org.signal.chat.attachments.GetStickerUploadFormResponse">message GetStickerUploadFormResponse</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>
pack_id
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A randomly-generated ID for the new sticker pack</p></td>
</tr>
<tr>
<td>2</td>
<td>
manifest_upload_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>An upload form clients must use to upload a manifest for the sticker pack</p></td>
</tr>
<tr>
<td>3</td>
<td>
sticker_upload_forms
</td>
<td>
<code title="org.signal.chat.common.S3UploadForm">
repeated
<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>Upload forms for individual stickers within the sticker pack</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">

185
grpc/org.signal.chat.backup.html
View File

@ -87,6 +87,15 @@
<p>
<a href="#message-org.signal.chat.backup.BackupStreamClosed">
<span class="tag" style="min-width: 6em">Message</span>
<code>BackupStreamClosed</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.backup.GetCdnCredentialsResponse.CdnCredentials">
<span class="tag" style="min-width: 6em">Message</span>
@ -791,7 +800,9 @@ provided key material before being copied.</p>
operations complete with detailed information about the outcome. If an
error is encountered, not all requests may be reflected in the responses.</p>
<p>On retries, a particular destination media id must not be reused with a
different source media id or different encryption parameters.</p></p>
different source media id or different encryption parameters.</p>
<p>The response stream may be closed with STREAM_CLOSED error reason. In this
case, a BackupStreamClosed message will be present in the error details.</p></p>
</div>
</div>
@ -836,7 +847,9 @@ via DeleteMedia.</p></p>
<div class="block">
<p><p>Delete media objects stored with this backup-id. Streams the locations of
media items back when the item has successfully been removed.</p></p>
media items back when the item has successfully been removed.</p>
<p>The response stream may be closed with STREAM_CLOSED error reason. In this
case, a BackupStreamClosed message will be present in the error details.</p></p>
</div>
</div>
@ -876,6 +889,75 @@ backups again, a public key must be resupplied.</p></p>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.backup.BackupStreamClosed">
<span>
<a href="#message-org.signal.chat.backup.BackupStreamClosed" title="org.signal.chat.backup.BackupStreamClosed">message BackupStreamClosed</a>
</span>
</h4>
<div class="block content">
<p>The reason why a media stream RPC is being prematurely closed by the server.</p>
</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 class="nohover"><td style="border: 0px"></td></tr>
<tr class="nohover">
<td class="oneof-heading" colspan="4">
<div class="oneof-heading">
<strong>oneof reason</strong>
</div>
</td>
</tr>
<tr>
<td>
1
</td>
<td>
failed_authentication
</td>
<td>
<code title="org.signal.chat.errors.FailedZkAuthentication">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedZkAuthentication"><span title="org.signal.chat.errors.FailedZkAuthentication">org.signal.chat.errors.FailedZkAuthentication</span>
</a>
</code>
</td>
<td class="content"><p>The provided backup auth credential presentation could not be
authenticated. Either, the presentation could not be verified, or
the public key signature was invalid, or there is no backup associated
with the backup-id in the presentation.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@ -992,9 +1074,9 @@ backups again, a public key must be resupplied.</p></p>
object_length
</td>
<td>
<code title="uint32">
<code title="uint64">
<span>uint32</span>
<span>uint64</span>
</code>
</td>
<td class="content"><p>The length of the source attachment before the encryption applied by the
@ -1203,29 +1285,6 @@ copy operation</p></td>
<td>
3
</td>
<td>
failed_authentication
</td>
<td>
<code title="org.signal.chat.errors.FailedZkAuthentication">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedZkAuthentication"><span title="org.signal.chat.errors.FailedZkAuthentication">org.signal.chat.errors.FailedZkAuthentication</span>
</a>
</code>
</td>
<td class="content"><p>The provided backup auth credential presentation could not be
authenticated. Either, the presentation could not be verified, or
the public key signature was invalid, or there is no backup associated
with the backup-id in the presentation.</p></td>
</tr>
<tr>
<td>
4
</td>
<td>
source_not_found
</td>
@ -1244,7 +1303,7 @@ with the backup-id in the presentation.</p></td>
<tr>
<td>
5
4
</td>
<td>
wrong_source_length
@ -1264,7 +1323,7 @@ with the backup-id in the presentation.</p></td>
<tr>
<td>
6
5
</td>
<td>
out_of_space
@ -1713,60 +1772,22 @@ with the backup-id in the presentation.</p></td>
</thead>
<tbody>
<tr>
<td>1</td>
<td>
deleted_item
</td>
<td>
<code title="org.signal.chat.backup.DeleteMediaItem">
<a href="org.signal.chat.backup.html#message-org.signal.chat.backup.DeleteMediaItem"><span title="org.signal.chat.backup.DeleteMediaItem">org.signal.chat.backup.DeleteMediaItem</span>
</a>
</code>
</td>
<td class="content"></td>
</tr>
<tr class="nohover"><td style="border: 0px"></td></tr>
<tr class="nohover">
<td class="oneof-heading" colspan="4">
<div class="oneof-heading">
<strong>oneof response</strong>
</div>
</td>
</tr>
<tr>
<td>
1
</td>
<td>
deleted_item
</td>
<td>
<code title="org.signal.chat.backup.DeleteMediaItem">
<a href="org.signal.chat.backup.html#message-org.signal.chat.backup.DeleteMediaItem"><span title="org.signal.chat.backup.DeleteMediaItem">org.signal.chat.backup.DeleteMediaItem</span>
</a>
</code>
</td>
<td class="content"></td>
</tr>
<tr>
<td>
2
</td>
<td>
failed_authentication
</td>
<td>
<code title="org.signal.chat.errors.FailedZkAuthentication">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedZkAuthentication"><span title="org.signal.chat.errors.FailedZkAuthentication">org.signal.chat.errors.FailedZkAuthentication</span>
</a>
</code>
</td>
<td class="content"><p>The provided backup auth credential presentation could not be
authenticated. Either, the presentation could not be verified, or
the public key signature was invalid, or there is no backup associated
with the backup-id in the presentation.</p></td>
</tr>
</tbody>
</table>

380
grpc/org.signal.chat.common.html
View File

@ -82,6 +82,24 @@
<p>
<a href="#message-org.signal.chat.common.Badge">
<span class="tag" style="min-width: 6em">Message</span>
<code>Badge</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.common.BadgeSvg">
<span class="tag" style="min-width: 6em">Message</span>
<code>BadgeSvg</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.common.EcPreKey">
<span class="tag" style="min-width: 6em">Message</span>
@ -111,6 +129,15 @@
<p>
<a href="#message-org.signal.chat.common.S3UploadForm">
<span class="tag" style="min-width: 6em">Message</span>
<code>S3UploadForm</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.common.ServiceIdentifier">
<span class="tag" style="min-width: 6em">Message</span>
@ -253,6 +280,216 @@ empty if no username is associated with the identified account.</p></td>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.common.Badge">
<span>
<a href="#message-org.signal.chat.common.Badge" title="org.signal.chat.common.Badge">message Badge</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>
id
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>An ID that uniquely identifies the badge.</p></td>
</tr>
<tr>
<td>2</td>
<td>
category
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The category the badge falls in ("donor" or "other").</p></td>
</tr>
<tr>
<td>3</td>
<td>
name
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The badge name.</p></td>
</tr>
<tr>
<td>4</td>
<td>
description
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The badge description.</p></td>
</tr>
<tr>
<td>5</td>
<td>
sprites6
</td>
<td>
<code title="string">
repeated
<span>string</span>
</code>
</td>
<td class="content"><p>Different size badge SVG files.</p></td>
</tr>
<tr>
<td>6</td>
<td>
svg
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>File name of the scalable vector graphic representing this badge.</p></td>
</tr>
<tr>
<td>7</td>
<td>
svgs
</td>
<td>
<code title="org.signal.chat.common.BadgeSvg">
repeated
<a href="org.signal.chat.common.html#message-org.signal.chat.common.BadgeSvg"><span title="org.signal.chat.common.BadgeSvg">org.signal.chat.common.BadgeSvg</span>
</a>
</code>
</td>
<td class="content"><p>Pairs of light/dark SVG files designed for display at different sizes.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.common.BadgeSvg">
<span>
<a href="#message-org.signal.chat.common.BadgeSvg" title="org.signal.chat.common.BadgeSvg">message BadgeSvg</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>
light
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>File name of the scalable vector graphic for light mode.</p></td>
</tr>
<tr>
<td>2</td>
<td>
dark
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>File name of the scalable vector graphic for dark mode.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@ -487,6 +724,149 @@ account/identity associated with this pre-key.</p></td>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.common.S3UploadForm">
<span>
<a href="#message-org.signal.chat.common.S3UploadForm" title="org.signal.chat.common.S3UploadForm">message S3UploadForm</a>
</span>
</h4>
<div class="block content">
<p>An upload location, credentials, and metadata which may be used to upload an
object to AWS S3</p>
</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>
key
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The S3 key (i.e. path and filename) for the uploaded file.</p></td>
</tr>
<tr>
<td>2</td>
<td>
credential
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A scoped credential. Includes the AWS access key, date, region targeted,
and AWS service.</p></td>
</tr>
<tr>
<td>3</td>
<td>
acl
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The type of access control for the uploaded file.</p></td>
</tr>
<tr>
<td>4</td>
<td>
algorithm
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The algorithm used to calculate a signature on the S3 policy.</p></td>
</tr>
<tr>
<td>5</td>
<td>
date
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The timestamp (formatted as "yyyyMMdd'T'HHmmssX") at which the S3 policy
and signature were generated.</p></td>
</tr>
<tr>
<td>6</td>
<td>
policy
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The S3 policy (as a base64-encoded JSON string) used to upload the file.</p></td>
</tr>
<tr>
<td>7</td>
<td>
signature
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A digital signature (formatted as a hex string) on the S3 policy.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">

169
grpc/org.signal.chat.messages.html
View File

@ -123,6 +123,15 @@
<p>
<a href="#message-org.signal.chat.messages.GetMessagesStreamClosed">
<span class="tag" style="min-width: 6em">Message</span>
<code>GetMessagesStreamClosed</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.messages.IndividualRecipientMessageBundle">
<span class="tag" style="min-width: 6em">Message</span>
@ -259,15 +268,6 @@
</p>
<p>
<a href="#message-org.signal.chat.messages.GetMessagesResponse.Terminated">
<span class="tag" style="min-width: 6em">Message</span>
<code>Terminated</code>
</a>
</p>
<p>
@ -377,8 +377,11 @@ has been processed (an ack). Acks should only be sent for messages
delivered via the currently open RPC.</p>
<p>Only the first GetMessagesRequest may contain request parameters that
configure the stream. The first request must not contain an ack.</p>
<p>The server will keep the stream open until the client disconnects or the
connection is displaced as indicated by a Terminated response.</p></p>
<p>The server will keep the stream open until the client disconnects. Only
one GetMessages stream may be open per device. If a second GetMessages
stream is opened, the server may terminate any of the streams with
a STREAM_CLOSED error reason. A GetMessagesStreamClosed message will be
present in the error details.</p></p>
</div>
</div>
@ -816,23 +819,68 @@ to deliver newly arrived messages.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.messages.GetMessagesStreamClosed">
<span>
<a href="#message-org.signal.chat.messages.GetMessagesStreamClosed" title="org.signal.chat.messages.GetMessagesStreamClosed">message GetMessagesStreamClosed</a>
</span>
</h4>
<div class="block content">
<p>The reason why a GetMessages RPC is being closed by the server.</p>
</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 class="nohover"><td style="border: 0px"></td></tr>
<tr class="nohover">
<td class="oneof-heading" colspan="4">
<div class="oneof-heading">
<strong>oneof reason</strong>
</div>
</td>
</tr>
<tr>
<td>
3
1
</td>
<td>
terminated
conflicting_stream
</td>
<td>
<code title="org.signal.chat.messages.GetMessagesResponse.Terminated">
<code title="google.protobuf.Empty">
<a href="org.signal.chat.messages.html#message-org.signal.chat.messages.GetMessagesResponse.Terminated"><span title="org.signal.chat.messages.GetMessagesResponse.Terminated">org.signal.chat.messages.GetMessagesResponse.Terminated</span>
</a>
<span>google.protobuf.Empty</span>
</code>
</td>
<td class="content"><p>Indicates that the stream is about to be closed.</p></td>
<td class="content"><p>Another caller has opened a GetMessages stream for the same device.</p></td>
</tr>
@ -2249,93 +2297,6 @@ delivery channel with a Signal server</p></td>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.messages.GetMessagesResponse.Terminated">
<span>
<a href="#message-org.signal.chat.messages.GetMessagesResponse.Terminated" title="org.signal.chat.messages.GetMessagesResponse.Terminated">message Terminated</a>
<br /><span style="font-size: 0.7em; font-weight: normal">(Nested in <a href="org.signal.chat.messages.html#message-org.signal.chat.messages.GetMessagesResponse"><span title="org.signal.chat.messages.GetMessagesResponse">org.signal.chat.messages.GetMessagesResponse</span>
</a>)</span>
</span>
</h4>
<div class="block content">
<p>The reason why a GetMessages RPC is being closed by the server.</p>
</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 class="nohover"><td style="border: 0px"></td></tr>
<tr class="nohover">
<td class="oneof-heading" colspan="4">
<div class="oneof-heading">
<strong>oneof reason</strong>
</div>
</td>
</tr>
<tr>
<td>
1
</td>
<td>
reauthentication_required
</td>
<td>
<code title="google.protobuf.Empty">
<span>google.protobuf.Empty</span>
</code>
</td>
<td class="content"><p>The account's credentials have been updated and the caller must reauthenticate.</p></td>
</tr>
<tr>
<td>
2
</td>
<td>
conflicting_stream
</td>
<td>
<code title="google.protobuf.Empty">
<span>google.protobuf.Empty</span>
</code>
</td>
<td class="content"><p>Another caller has opened a GetMessages stream for the same device.</p></td>
</tr>
</tbody>
</table>
</div>

385
grpc/org.signal.chat.profile.html
View File

@ -87,24 +87,6 @@
<p>
<a href="#message-org.signal.chat.profile.Badge">
<span class="tag" style="min-width: 6em">Message</span>
<code>Badge</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.profile.BadgeSvg">
<span class="tag" style="min-width: 6em">Message</span>
<code>BadgeSvg</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.profile.DataEtag">
<span class="tag" style="min-width: 6em">Message</span>
@ -258,15 +240,6 @@
<p>
<a href="#message-org.signal.chat.profile.ProfileAvatarUploadAttributes">
<span class="tag" style="min-width: 6em">Message</span>
<code>ProfileAvatarUploadAttributes</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.profile.ProfilesV2CapabilityRequired">
<span class="tag" style="min-width: 6em">Message</span>
@ -510,216 +483,6 @@ methods in <code>Profile</code> instead.</p></p>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.Badge">
<span>
<a href="#message-org.signal.chat.profile.Badge" title="org.signal.chat.profile.Badge">message Badge</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>
id
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>An ID that uniquely identifies the badge.</p></td>
</tr>
<tr>
<td>2</td>
<td>
category
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The category the badge falls in ("donor" or "other").</p></td>
</tr>
<tr>
<td>3</td>
<td>
name
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The badge name.</p></td>
</tr>
<tr>
<td>4</td>
<td>
description
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The badge description.</p></td>
</tr>
<tr>
<td>5</td>
<td>
sprites6
</td>
<td>
<code title="string">
repeated
<span>string</span>
</code>
</td>
<td class="content"><p>Different size badge SVG files.</p></td>
</tr>
<tr>
<td>6</td>
<td>
svg
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>File name of the scalable vector graphic representing this badge.</p></td>
</tr>
<tr>
<td>7</td>
<td>
svgs
</td>
<td>
<code title="org.signal.chat.profile.BadgeSvg">
repeated
<a href="org.signal.chat.profile.html#message-org.signal.chat.profile.BadgeSvg"><span title="org.signal.chat.profile.BadgeSvg">org.signal.chat.profile.BadgeSvg</span>
</a>
</code>
</td>
<td class="content"><p>Pairs of light/dark SVG files designed for display at different sizes.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.BadgeSvg">
<span>
<a href="#message-org.signal.chat.profile.BadgeSvg" title="org.signal.chat.profile.BadgeSvg">message BadgeSvg</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>
light
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>File name of the scalable vector graphic for light mode.</p></td>
</tr>
<tr>
<td>2</td>
<td>
dark
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>File name of the scalable vector graphic for dark mode.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@ -1548,11 +1311,11 @@ the request.</p></td>
badges
</td>
<td>
<code title="org.signal.chat.profile.Badge">
<code title="org.signal.chat.common.Badge">
repeated
<a href="org.signal.chat.profile.html#message-org.signal.chat.profile.Badge"><span title="org.signal.chat.profile.Badge">org.signal.chat.profile.Badge</span>
<a href="org.signal.chat.common.html#message-org.signal.chat.common.Badge"><span title="org.signal.chat.common.Badge">org.signal.chat.common.Badge</span>
</a>
</code>
</td>
@ -2231,146 +1994,6 @@ due to a disallowed country prefix on the account's phone number.</p>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.profile.ProfileAvatarUploadAttributes">
<span>
<a href="#message-org.signal.chat.profile.ProfileAvatarUploadAttributes" title="org.signal.chat.profile.ProfileAvatarUploadAttributes">message ProfileAvatarUploadAttributes</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>
path
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The S3 upload path for the profile's avatar.</p></td>
</tr>
<tr>
<td>2</td>
<td>
credential
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A scoped credential. Includes the AWS access key, date, region targeted, and AWS service.</p></td>
</tr>
<tr>
<td>3</td>
<td>
acl
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The type of access control for the avatar object.</p></td>
</tr>
<tr>
<td>4</td>
<td>
algorithm
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The algorithm used to calculate a signature on the S3 policy.</p></td>
</tr>
<tr>
<td>5</td>
<td>
date
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The timestamp at which the S3 policy and signature were generated.</p></td>
</tr>
<tr>
<td>6</td>
<td>
policy
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The S3 policy used to upload the avatar object.</p></td>
</tr>
<tr>
<td>7</td>
<td>
signature
</td>
<td>
<code title="bytes">
<span>bytes</span>
</code>
</td>
<td class="content"><p>A digital signature on the S3 policy.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@ -2756,11 +2379,11 @@ field number without serialization overhead. This is purely aesthetic.</p></td>
v1_avatar_upload_form
</td>
<td>
<code title="org.signal.chat.profile.ProfileAvatarUploadAttributes">
<code title="org.signal.chat.common.S3UploadForm">
optional
<a href="org.signal.chat.profile.html#message-org.signal.chat.profile.ProfileAvatarUploadAttributes"><span title="org.signal.chat.profile.ProfileAvatarUploadAttributes">org.signal.chat.profile.ProfileAvatarUploadAttributes</span>
<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>

4706
grpc/org.signal.chat.subscriptions.html Normal file
View File

File diff suppressed because it is too large Load Diff

4
grpc/search.html
View File

File diff suppressed because one or more lines are too long

11
signal-server-openapi.yaml
View File

@ -6375,6 +6375,14 @@ components:
items:
type: string
description: The payment methods that support the given currency
enum:
- UNKNOWN
- CARD
- PAYPAL
- SEPA_DEBIT
- IDEAL
- GOOGLE_PLAY_BILLING
- APPLE_APP_STORE
description: Configuration for a currency - use to present appropriate client
interfaces
GetSubscriptionConfigurationResponse:
@ -6405,9 +6413,6 @@ components:
LevelConfiguration:
type: object
properties:
name:
type: string
description: The localized name for the level
badge:
$ref: "#/components/schemas/Badge"
description: Configuration for a donation level - use to present appropriate