1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SYNC_BASE_ACCOUNT_PREF_UTILS_H_
#define COMPONENTS_SYNC_BASE_ACCOUNT_PREF_UTILS_H_
#include <vector>
#include "base/values.h"
namespace signin {
class GaiaIdHash;
} // namespace signin
class PrefService;
namespace syncer {
// Helpers to ease the use of account-keyed prefs. These prefs are structured as
// follows. Note that the leaf values may be any `base::Value` type, and special
// helpers exist for dictionaries (pref_path2 in the example):
//
// {
// "pref_path1": {
// "base64_gaia_id_hash1": "value1",
// "base64_gaia_id_hash2": "value2"
// },
// "pref_path2": {
// "base64_gaia_id_hash1": {
// "key1": "value1",
// "key2": 123
// },
// "base64_gaia_id_hash2": {
// "key1": "value2",
// "key2": 456
// }
// }
// }
// In the account-keyed pref at `pref_path` (which must be a valid registered
// pref), looks up the entry corresponding to `gaia_id_hash` and returns the
// corresponding value. If the `gaia_id_hash` isn't found, returns null.
const base::Value* GetAccountKeyedPrefValue(
const PrefService* pref_service,
const char* pref_path,
const signin::GaiaIdHash& gaia_id_hash);
// In the account-keyed pref at `pref_path` (which must be a valid registered
// pref), sets the value for the given `gaia_id_hash` to `value`.
void SetAccountKeyedPrefValue(PrefService* pref_service,
const char* pref_path,
const signin::GaiaIdHash& gaia_id_hash,
base::Value value);
// In the account-keyed pref at `pref_path` (which must be a valid registered
// pref), clears any value for the given `gaia_id_hash`.
void ClearAccountKeyedPrefValue(PrefService* pref_service,
const char* pref_path,
const signin::GaiaIdHash& gaia_id_hash);
// In the account-keyed dictionary pref at `pref_path` (which must be a valid
// registered pref), looks up the entry corresponding to `gaia_id_hash`, and
// within that, further looks up the `key` and returns the corresponding value.
// If either the `gaia_id_hash` or the `key` aren't found, returns null.
const base::Value* GetAccountKeyedPrefDictEntry(
const PrefService* pref_service,
const char* pref_path,
const signin::GaiaIdHash& gaia_id_hash,
const char* key);
// In the account-keyed dictionary pref at `pref_path` (which must be a valid
// registered pref), sets the value under `key` for the given `gaia_id_hash` to
// `value`, creating the entry if required.
void SetAccountKeyedPrefDictEntry(PrefService* pref_service,
const char* pref_path,
const signin::GaiaIdHash& gaia_id_hash,
const char* key,
base::Value value);
// In the account-keyed dictionary pref at `pref_path` (which must be a valid
// registered pref), removes any value under `key` for the given `gaia_id_hash`.
void RemoveAccountKeyedPrefDictEntry(PrefService* pref_service,
const char* pref_path,
const signin::GaiaIdHash& gaia_id_hash,
const char* key);
// For the account-keyed pref at `pref_path` (which must be a valid registered
// pref), drops all entries for accounts that are *not* listed in
// `available_gaia_ids`.
void KeepAccountKeyedPrefValuesOnlyForUsers(
PrefService* pref_service,
const char* pref_path,
const std::vector<signin::GaiaIdHash>& available_gaia_ids);
} // namespace syncer
#endif // COMPONENTS_SYNC_BASE_ACCOUNT_PREF_UTILS_H_
|
