Better Comments on History Keys

This commit is contained in:
Sarah Jamie Lewis 2023-08-14 13:18:35 -07:00
parent 066ed86598
commit e1877d69b7
1 changed files with 7 additions and 5 deletions

View File

@ -327,18 +327,20 @@ const (
ContextSendFile = "im.cwtch.file.send.chunk"
)
// Define Default Attribute Keys
// Define Attribute Keys related to history preservation
const (
SaveHistoryDefaultKey = "SaveHistoryDefault" // profile level default
SaveHistoryKey = "SavePeerHistory"
DeleteHistoryDefault = "DefaultDeleteHistory" // used at both profile and contact level.
)
// Define Default Attribute Values
const (
// Save History has 3 distinct states. By default we don't save history (DefaultDeleteHistory), if the peer confirms this
// we change to DeleteHistoryConfirmed, if they confirm they want to save then this becomes SaveHistoryConfirmed
// We use this distinction between default and confirmed to drive UI
DeleteHistoryDefault = "DefaultDeleteHistory"
// Save History has 3 distinct states. By default we refer to the profile level
// attribute SaveHistoryDefaultKey ( default: unset i.e. DefaultDeleteHistory),
// For each contact, if the profile owner confirms this we change to DeleteHistoryConfirmed,
// if the profile owner confirms they want to save history then this becomes SaveHistoryConfirmed
// These settings are set at the UI level usig SetScopeZoneAttribute local.profile.*
SaveHistoryConfirmed = "SaveHistory"
DeleteHistoryConfirmed = "DeleteHistoryConfirmed"
SaveHistoryDefault = "DefaultSaveHistory"