Skip to content

Commit

Permalink
fix domain + udapte comments
Browse files Browse the repository at this point in the history
  • Loading branch information
BillCarsonFr committed Mar 21, 2024
1 parent 05ea51e commit 9e1c84b
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
10 changes: 5 additions & 5 deletions schemas/Error.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
"name": {
"type": "string",
"oneOf": [
{"const": "OlmIndexError", "description": "E2E domain error. The room key is known but is ratcheted (index > 0)."},
{"const": "OlmKeysNotSentError", "description": "E2E domain error. Generic unknown inbound group session error."},
{"const": "OlmUnspecifiedError", "description": "E2E domain error. Any other decryption error (missing field, format errors...)."},
{"const": "UnknownError", "description": "E2E domain error. Decryption failed due to unknown error."},
{"const": "HistoricalMessage", "description": "E2E domain error. Decryption failed for a message sent before the device logged in, and key backup is not enabled."},
{"const": "OlmIndexError", "description": "E2EE domain error. The room key is known but is ratcheted (index > 0)."},
{"const": "OlmKeysNotSentError", "description": "E2EE domain error. Generic unknown inbound group session error."},
{"const": "OlmUnspecifiedError", "description": "E2EE domain error. Any other decryption error (missing field, format errors...)."},
{"const": "UnknownError", "description": "E2EE domain error. Decryption failed due to unknown error."},
{"const": "HistoricalMessage", "description": "E2EE domain error. Decryption failed for a message sent before the device logged in, and key backup is not enabled."},
{"const": "VoipUserHangup", "description": "VOIP domain error. The user hung up the call."},
{"const": "VoipIceFailed", "description": "VOIP domain error. ICE negotiation failed."},
{"const": "VoipInviteTimeout", "description": "VOIP domain error. The call invite timed out."},
Expand Down
13 changes: 7 additions & 6 deletions types/kotlin2/Error.kt
Original file line number Diff line number Diff line change
Expand Up @@ -56,23 +56,24 @@ data class Error(
enum class Name {

/**
* E2E domain error. Decryption fails for historical message and there
* is no backup.
* E2EE domain error. Decryption failed for a message sent before the
* device logged in, and key backup is not enabled.
*/
HistoricalMessage,

/**
* E2E domain error. The room key is known but is ratcheted (index > 0).
* E2EE domain error. The room key is known but is ratcheted (index >
* 0).
*/
OlmIndexError,

/**
* E2E domain error. Generic unknown inbound group session error.
* E2EE domain error. Generic unknown inbound group session error.
*/
OlmKeysNotSentError,

/**
* E2E domain error. Any other decryption error (missing field, format
* E2EE domain error. Any other decryption error (missing field, format
* errors...).
*/
OlmUnspecifiedError,
Expand All @@ -83,7 +84,7 @@ data class Error(
ToDeviceFailedToDecrypt,

/**
* E2E domain error. Decryption fails due to unknown error.
* E2EE domain error. Decryption failed due to unknown error.
*/
UnknownError,

Expand Down
10 changes: 5 additions & 5 deletions types/swift/Error.swift
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,17 @@ extension AnalyticsEvent {
}

public enum Name: String {
/// E2E domain error. Decryption fails for historical message and there is no backup.
/// E2EE domain error. Decryption failed for a message sent before the device logged in, and key backup is not enabled.
case HistoricalMessage
/// E2E domain error. The room key is known but is ratcheted (index > 0).
/// E2EE domain error. The room key is known but is ratcheted (index > 0).
case OlmIndexError
/// E2E domain error. Generic unknown inbound group session error.
/// E2EE domain error. Generic unknown inbound group session error.
case OlmKeysNotSentError
/// E2E domain error. Any other decryption error (missing field, format errors...).
/// E2EE domain error. Any other decryption error (missing field, format errors...).
case OlmUnspecifiedError
/// TO_DEVICE domain error. The to-device message failed to decrypt.
case ToDeviceFailedToDecrypt
/// E2E domain error. Decryption fails due to unknown error.
/// E2EE domain error. Decryption failed due to unknown error.
case UnknownError
/// VOIP domain error. ICE negotiation failed.
case VoipIceFailed
Expand Down

0 comments on commit 9e1c84b

Please sign in to comment.