package org.signal.chat.remoteconfiguration

Get desktop application:
View/edit binary Protocol Buffers messages

Provides remote configuration applicable to the authenticated user

• rpc GetBadges (GetBadgesRequest, GetBadgesResponse)

  remote_configuration.proto:33

  Returns detailed information for all configured badges, keyed by badge ID. Badge descriptions may contain localized strings. Callers should set their language preferences via an "Accept-Language" header on the request https://datatracker.ietf.org/doc/html/rfc3282#section-3 Callers may cache a badges result for up to 1 day before checking (via etag) if there are any new updates.

  message GetBadgesRequest

  remote_configuration.proto:69

  • bytes etag = 1

    If present, the etag from a prior GetBadgesResponse. If the provided etag matches the current badge etag, the server may elide the badge response.

  message GetBadgesResponse

  remote_configuration.proto:75

  • oneof response

    • TaggedBadges tagged_badges = 1

      The full set of badges and corresponding etag.

    • bool etag_matched = 2

      The etag in the request matched the current badge etag.

• rpc GetConfiguration (GetConfigurationRequest, GetConfigurationResponse)

  remote_configuration.proto:23

  Fetches the configuration for the authenticated user. Returned values are based on the authenticated account and caller's client platform, which is derived from the "User-Agent" header.

  message GetConfigurationRequest

  remote_configuration.proto:36

  • bytes etag = 1

    If present, the etag from a prior GetConfigurationResponse. If the provided etag matches the current configuration etag, the server may elide the configuration response.

  message GetConfigurationResponse

  remote_configuration.proto:43

  • oneof response

    • TaggedConfiguration tagged_configuration = 1

      The full configuration and corresponding etag.

    • bool etag_matched = 2

      The etag in the request matched the current configuration etag.

Used in: TaggedBadges

• map<string, common.Badge> badges = 1

  A map of badge ID to the detailed information for that badge.

Used in: TaggedConfiguration

• map<string, string> configuration = 1

  A map of namespaced configuration keys to their resolved values. All configuration values are represented as strings. boolean values are represented as the strings "true" or "false".

Used in: GetBadgesResponse

• optional Badges badges = 1

• bytes etag = 2

  An entity tag for `badges`. This may be supplied in a subsequent request to optimize bandwidth when the set of badges has not changed.

Used in: GetConfigurationResponse

• optional Configuration configuration = 1

• bytes etag = 2

  An entity tag for `configuration`. This may be supplied in a subsequent request to optimize bandwidth when the configuration has not changed.