package common

Get desktop application:
View/edit binary Protocol Buffers messages

Threema Blob to be uploaded/downloaded from the Blob server.

Used in: Image

bytes id = 1
Blob ID as given by the Blob server
bytes nonce = 2
Nonce used for encrypting/decrypting the Blob. Note: May be omitted if unambigously defined by the context.
bytes key = 3
Secret (or public) key used for encrypting/decrypting the Blob. Note: May be omitted if unambigously defined by the context.
uint64 uploaded_at = 4
Unix-ish timestamp in milliseconds when the blob has been uploaded

Inline Blob data.

Used in: history.SdToDd, join.EdToNd

bytes id = 1
Associated Blob ID
bytes data = 2
The Blob's data

E2E message type as defined by the Chat Server Protocol.

Used in: d2d.IncomingMessage, d2d.OutgoingMessage

_INVALID_TYPE = 0
Invalid message type
EMPTY = 252
[`empty`](ref:e2e.empty)
TEXT = 1
[`text`](ref:e2e.text)
DEPRECATED_IMAGE = 2
[`deprecated-image`](ref:e2e.deprecated-image)
LOCATION = 16
[`location`](ref:e2e.location)
DEPRECATED_AUDIO = 20
[`deprecated-audio`](ref:e2e.deprecated-audio)
DEPRECATED_VIDEO = 19
[`deprecated-video`](ref:e2e.deprecated-video)
FILE = 23
[`file`](ref:e2e.file)
POLL_SETUP = 21
[`poll-setup`](ref:e2e.poll-setup)
POLL_VOTE = 22
[`poll-vote`](ref:e2e.poll-vote)
CALL_OFFER = 96
[`call-offer`](ref:e2e.call-offer)
CALL_ANSWER = 97
[`call-answer`](ref:e2e.call-answer)
CALL_ICE_CANDIDATE = 98
[`call-ice-candidate`](ref:e2e.call-ice-candidate)
CALL_HANGUP = 99
[`call-hangup`](ref:e2e.call-hangup)
CALL_RINGING = 100
[`call-ringing`](ref:e2e.call-ringing)
DELIVERY_RECEIPT = 128
[`delivery-receipt`](ref:e2e.delivery-receipt)
TYPING_INDICATOR = 144
[`typing-indicator`](ref:e2e.typing-indicator)
REACTION = 130
`csp-e2e.Reaction`
EDIT_MESSAGE = 145
`csp-e2e.EditMessage`
DELETE_MESSAGE = 146
`csp-e2e.DeleteMessage`
CONTACT_SET_PROFILE_PICTURE = 24
[`set-profile-picture`](ref:e2e.set-profile-picture) of a contact
CONTACT_DELETE_PROFILE_PICTURE = 25
[`delete-profile-picture`](ref:e2e.delete-profile-picture) of a contact
CONTACT_REQUEST_PROFILE_PICTURE = 26
[`contact-request-profile-picture`](ref:e2e.contact-request-profile-picture)
GROUP_JOIN_REQUEST = 77
`csp-e2e.GroupJoinRequest`
GROUP_JOIN_RESPONSE = 78
`csp-e2e.GroupJoinResponse`
GROUP_SETUP = 74
[`group-setup`](ref:e2e.group-setup) wrapped by [`group-creator-container`](ref:e2e.group-creator-container)
GROUP_NAME = 75
[`group-name`](ref:e2e.group-name) wrapped by [`group-creator-container`](ref:e2e.group-creator-container)
GROUP_LEAVE = 76
[`group-leave`](ref:e2e.group-leave) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_SET_PROFILE_PICTURE = 80
[`set-profile-picture`](ref:e2e.set-profile-picture) wrapped by [`group-creator-container`](ref:e2e.group-creator-container)
GROUP_DELETE_PROFILE_PICTURE = 84
[`delete-profile-picture`](ref:e2e.delete-profile-picture) wrapped by [`group-creator-container`](ref:e2e.group-creator-container)
GROUP_SYNC_REQUEST = 81
[`group-sync-request`](ref:e2e.group-sync-request) wrapped by [`group-creator-container`](ref:e2e.group-creator-container)
GROUP_CALL_START = 79
`csp-e2e.GroupCallStart` wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_TEXT = 65
`0x41`: [`text`](ref:e2e.text) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_LOCATION = 66
[`location`](ref:e2e.location) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_IMAGE = 67
[`deprecated-group-image`](ref:e2e.deprecated-group-image) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_AUDIO = 69
[`deprecated-audio`](ref:e2e.deprecated-audio) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_VIDEO = 68
[`deprecated-video`](ref:e2e.deprecated-video) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_FILE = 70
[`file`](ref:e2e.file) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_POLL_SETUP = 82
[`poll-setup`](ref:e2e.poll-setup) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_POLL_VOTE = 83
[`poll-vote`](ref:e2e.poll-vote) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_DELIVERY_RECEIPT = 129
[`delivery-receipt`](ref:e2e.delivery-receipt) wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_EDIT_MESSAGE = 147
`csp-e2e.EditMessage` wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_DELETE_MESSAGE = 148
`csp-e2e.DeleteMessage` wrapped by [`group-member-container`](ref:e2e.group-member-container)
GROUP_REACTION = 131
`csp-e2e.Reaction` wrapped by [`group-member-container`](ref:e2e.group-member-container)
FORWARD_SECURITY_ENVELOPE = 160
`csp-e2e-fs.Envelope`
WEB_SESSION_RESUME = 254
[`web-session-resume`](ref:e2e.web-session-resume)

CSP features supported by a device or available for a contact (64 bit mask). IMPORTANT: The flags determine what a device/contact is capable of, not whether the settings allow for it. For example, group calls may be supported but ignored if disabled in the settings.

NONE = 0
No features available
VOICE_MESSAGE_SUPPORT = 1
Supports voice messages.
GROUP_SUPPORT = 2
Supports groups.
POLL_SUPPORT = 4
Supports polls.
FILE_MESSAGE_SUPPORT = 8
Supports file messages.
O2O_AUDIO_CALL_SUPPORT = 16
Supports 1:1 audio calls.
O2O_VIDEO_CALL_SUPPORT = 32
Supports 1:1 video calls.
FORWARD_SECURITY_SUPPORT = 64
Supports forward security.
GROUP_CALL_SUPPORT = 128
Supports group calls.
EDIT_MESSAGE_SUPPORT = 256
Supports editing messages.
DELETE_MESSAGE_SUPPORT = 512
Supports deleting messages.
REACTION_SUPPORT = 1024
Supports (new-style) reactions.

Generic image allowing delta updates Note: Lack of presence generally means that the image should remain unchanged.

Used in: sync.Contact, sync.Group, sync.UserProfile

oneof image
- Unit removed = 1
  The image is empty or was explicitly removed
- Image updated = 2
  The new updated image

Unique group identity.

Used in: csp_e2e_fs.Encapsulated, csp_e2e_fs.Reject, d2d.ConversationId, d2d.GroupSync.Delete, sync.Group

fixed64 group_id = 1
Group id as chosen by the group's creator
string creator_identity = 2
Threema ID of the group's creator

Container for a list of identities.

Used in: sync.DistributionList, sync.Group, sync.Settings, sync.UserProfile.ProfilePictureShareWith

repeated string identities = 1
List of identities

Generic image.

Used in: DeltaImage

Image.Type type = 1
optional Blob blob = 2
The image's associated blob.

Format type of the image

Used in: Image

JPEG = 0

Generic 2D resolution

Used in: callsignaling.VideoQualityProfile, groupcall.ParticipantToSfu.ParticipantCamera.Subscribe

uint32 width = 1
uint32 height = 2

Timespan (year 1970+) with milliseconds accuracy. Note: This message is invalid if `to` is smaller than `from`.

Used in: history.GetSummary

uint64 from = 1
Start of the timespan (Unix-ish timestamp in milliseconds, inclusive)
uint64 to = 2
End of the timespan (Unix-ish timestamp in miliseconds, inclusive)

A unit that may be used in a `oneof` option without any values. Note: We're using this to simulate tagged unions.

Used in: DeltaImage, csp_e2e.GroupJoinResponse.Response, groupcall.ParticipantToParticipant.CaptureState.Camera, groupcall.ParticipantToParticipant.CaptureState.Microphone, groupcall.ParticipantToParticipant.CaptureState.Screen, sync.Contact.NotificationSoundPolicyOverride, sync.Contact.NotificationTriggerPolicyOverride, sync.Contact.ReadReceiptPolicyOverride, sync.Contact.TypingIndicatorPolicyOverride, sync.Group.NotificationSoundPolicyOverride, sync.Group.NotificationTriggerPolicyOverride, sync.UserProfile.ProfilePictureShareWith, url.DeviceGroupJoinRequestOrOffer.Variant

(message has no fields)

package common

message Blob

bytes id = 1

bytes nonce = 2

bytes key = 3

uint64 uploaded_at = 4

message BlobData

bytes id = 1

bytes data = 2

enum CspE2eMessageType

_INVALID_TYPE = 0

EMPTY = 252

TEXT = 1

DEPRECATED_IMAGE = 2

LOCATION = 16

DEPRECATED_AUDIO = 20

DEPRECATED_VIDEO = 19

FILE = 23

POLL_SETUP = 21

POLL_VOTE = 22

CALL_OFFER = 96

CALL_ANSWER = 97

CALL_ICE_CANDIDATE = 98

CALL_HANGUP = 99

CALL_RINGING = 100

DELIVERY_RECEIPT = 128

TYPING_INDICATOR = 144

REACTION = 130

EDIT_MESSAGE = 145

DELETE_MESSAGE = 146

CONTACT_SET_PROFILE_PICTURE = 24

CONTACT_DELETE_PROFILE_PICTURE = 25

CONTACT_REQUEST_PROFILE_PICTURE = 26

GROUP_JOIN_REQUEST = 77

GROUP_JOIN_RESPONSE = 78

GROUP_SETUP = 74

GROUP_NAME = 75

GROUP_LEAVE = 76

GROUP_SET_PROFILE_PICTURE = 80

GROUP_DELETE_PROFILE_PICTURE = 84

GROUP_SYNC_REQUEST = 81

GROUP_CALL_START = 79

GROUP_TEXT = 65

GROUP_LOCATION = 66

GROUP_IMAGE = 67

GROUP_AUDIO = 69

GROUP_VIDEO = 68

GROUP_FILE = 70

GROUP_POLL_SETUP = 82

GROUP_POLL_VOTE = 83

GROUP_DELIVERY_RECEIPT = 129

GROUP_EDIT_MESSAGE = 147

GROUP_DELETE_MESSAGE = 148

GROUP_REACTION = 131

FORWARD_SECURITY_ENVELOPE = 160

WEB_SESSION_RESUME = 254

enum CspFeatureMaskFlag

NONE = 0

VOICE_MESSAGE_SUPPORT = 1

GROUP_SUPPORT = 2

POLL_SUPPORT = 4

FILE_MESSAGE_SUPPORT = 8

O2O_AUDIO_CALL_SUPPORT = 16

O2O_VIDEO_CALL_SUPPORT = 32

FORWARD_SECURITY_SUPPORT = 64

GROUP_CALL_SUPPORT = 128

EDIT_MESSAGE_SUPPORT = 256

DELETE_MESSAGE_SUPPORT = 512

REACTION_SUPPORT = 1024

message DeltaImage

oneof image

Unit removed = 1

Image updated = 2

message GroupIdentity

fixed64 group_id = 1

string creator_identity = 2

message Identities

repeated string identities = 1

message Image

Image.Type type = 1