• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef OS_ACCOUNT_FRAMEWORKS_OSACCOUNT_CORE_INCLUDE_IOS_ACCOUNT_H
17 #define OS_ACCOUNT_FRAMEWORKS_OSACCOUNT_CORE_INCLUDE_IOS_ACCOUNT_H
18 
19 #include <string>
20 #include "iremote_broker.h"
21 #include "iremote_object.h"
22 #include "os_account_info.h"
23 #include "account_error_no.h"
24 #include "os_account_constants.h"
25 #include "os_account_event_listener.h"
26 
27 namespace OHOS {
28 namespace AccountSA {
29 class IOsAccount : public IRemoteBroker {
30 public:
31     DECLARE_INTERFACE_DESCRIPTOR(u"ohos.accountfwk.IOsAccount");
32 
33     virtual ErrCode CreateOsAccount(
34         const std::string &name, const OsAccountType &type, OsAccountInfo &osAccountInfo) = 0;
35     virtual ErrCode CreateOsAccountForDomain(
36         const OsAccountType &type, const DomainAccountInfo &domainInfo, OsAccountInfo &osAccountInfo) = 0;
37     virtual ErrCode RemoveOsAccount(const int id) = 0;
38     virtual ErrCode IsOsAccountExists(const int id, bool &isOsAccountExists) = 0;
39     virtual ErrCode IsOsAccountActived(const int id, bool &isOsAccountActived) = 0;
40     virtual ErrCode IsOsAccountConstraintEnable(
41         const int id, const std::string &constraint, bool &isConstraintEnable) = 0;
42     virtual ErrCode CheckOsAccountConstraintEnabled(
43         const int id, const std::string &constraint, bool &isEnabled) = 0;
44     virtual ErrCode IsOsAccountVerified(const int id, bool &isVerified) = 0;
45     virtual ErrCode GetCreatedOsAccountsCount(unsigned int &osAccountsCount) = 0;
46     virtual ErrCode GetOsAccountLocalIdFromProcess(int &id) = 0;
47     virtual ErrCode IsMainOsAccount(bool &isMainOsAccount) = 0;
48     virtual ErrCode GetOsAccountLocalIdFromDomain(const DomainAccountInfo &domainInfo, int &id) = 0;
49     virtual ErrCode QueryMaxOsAccountNumber(int &maxOsAccountNumber) = 0;
50     virtual ErrCode GetOsAccountAllConstraints(const int id, std::vector<std::string> &constraints) = 0;
51     virtual ErrCode QueryAllCreatedOsAccounts(std::vector<OsAccountInfo> &osAccountInfos) = 0;
52     virtual ErrCode QueryCurrentOsAccount(OsAccountInfo &osAccountInfo) = 0;
53     virtual ErrCode QueryOsAccountById(const int id, OsAccountInfo &osAccountInfo) = 0;
54     virtual ErrCode GetOsAccountTypeFromProcess(OsAccountType &type) = 0;
55     virtual ErrCode GetOsAccountProfilePhoto(const int id, std::string &photo) = 0;
56     virtual ErrCode IsMultiOsAccountEnable(bool &isMultiOsAccountEnable) = 0;
57     virtual ErrCode SetOsAccountName(const int id, const std::string &localName) = 0;
58     virtual ErrCode SetOsAccountConstraints(
59         const int id, const std::vector<std::string> &constraints, const bool enable) = 0;
60     virtual ErrCode SetOsAccountProfilePhoto(const int id, const std::string &photo) = 0;
61     virtual ErrCode ActivateOsAccount(const int id) = 0;
62     virtual ErrCode StartOsAccount(const int id) = 0;
63     virtual ErrCode StopOsAccount(const int id) = 0;
64     virtual ErrCode GetOsAccountLocalIdBySerialNumber(const int64_t serialNumber, int &id) = 0;
65     virtual ErrCode GetSerialNumberByOsAccountLocalId(const int &id, int64_t &serialNumber) = 0;
66     virtual ErrCode SubscribeOsAccount(
67         const OsAccountSubscribeInfo &subscribeInfo, const sptr<IRemoteObject> &eventListener) = 0;
68     virtual ErrCode UnsubscribeOsAccount(const sptr<IRemoteObject> &eventListener) = 0;
69     virtual OS_ACCOUNT_SWITCH_MOD GetOsAccountSwitchMod() = 0;
70     virtual ErrCode IsCurrentOsAccountVerified(bool &isVerified) = 0;
71     virtual ErrCode IsOsAccountCompleted(const int id, bool &isOsAccountCompleted) = 0;
72     virtual ErrCode SetCurrentOsAccountIsVerified(const bool isVerified) = 0;
73     virtual ErrCode SetOsAccountIsVerified(const int id, const bool isVerified) = 0;
74     virtual ErrCode DumpState(const int &id, std::vector<std::string> &state) = 0;
75 
76     virtual void CreateBasicAccounts() = 0;
77     virtual ErrCode GetCreatedOsAccountNumFromDatabase(const std::string& storeID,
78         int &createdOsAccountNum) = 0;
79     virtual ErrCode GetSerialNumberFromDatabase(const std::string& storeID, int64_t &serialNumber) = 0;
80     virtual ErrCode GetMaxAllowCreateIdFromDatabase(const std::string& storeID, int &id) = 0;
81     virtual ErrCode GetOsAccountFromDatabase(const std::string& storeID, const int id,
82         OsAccountInfo &osAccountInfo) = 0;
83     virtual ErrCode GetOsAccountListFromDatabase(const std::string& storeID,
84         std::vector<OsAccountInfo> &osAccountList) = 0;
85     virtual ErrCode QueryActiveOsAccountIds(std::vector<int32_t>& ids) = 0;
86     virtual ErrCode QueryOsAccountConstraintSourceTypes(const int32_t id,
87         const std::string &constraint, std::vector<ConstraintSourceTypeInfo> &constraintSourceTypeInfos) = 0;
88     virtual ErrCode SetGlobalOsAccountConstraints(const std::vector<std::string> &constraints,
89         const bool enable, const int32_t enforcerId, const bool isDeviceOwner) = 0;
90     virtual ErrCode SetSpecificOsAccountConstraints(const std::vector<std::string> &constraints,
91         const bool enable, const int32_t targetId, const int32_t enforcerId, const bool isDeviceOwner) = 0;
92 
93     enum class Message {
94         CREATE_OS_ACCOUNT = 0,
95         CREATE_OS_ACCOUNT_FOR_DOMAIN,
96         REMOVE_OS_ACCOUNT,
97         IS_OS_ACCOUNT_EXISTS,
98         IS_OS_ACCOUNT_ACTIVED,
99         IS_OS_ACCOUNT_CONSTRAINT_ENABLE,
100         CHECK_OS_ACCOUNT_CONSTRAINT_ENABLED,
101         IS_OS_ACCOUNT_VERIFIED,
102         GET_CREATED_OS_ACCOUNT_COUNT,
103         GET_OS_ACCOUNT_LOCAL_ID_FROM_PROCESS,
104         IS_MAIN_OS_ACCOUNT,
105         GET_OS_ACCOUNT_LOCAL_ID_FROM_DOMAIN,
106         QUERY_MAX_OS_ACCOUNT_NUMBER,
107         GET_OS_ACCOUNT_ALL_CONSTRAINTS,
108         QUERY_ALL_CREATED_OS_ACCOUNTS,
109         QUERY_CURRENT_OS_ACCOUNT,
110         QUERY_OS_ACCOUNT_BY_ID,
111         GET_OS_ACCOUNT_TYPE_FROM_PROCESS,
112         GET_OS_ACCOUNT_PROFILE_PHOTO,
113         IS_MULTI_OS_ACCOUNT_ENABLE,
114         SET_OS_ACCOUNT_NAME,
115         SET_OS_ACCOUNT_CONSTRAINTS,
116         SET_OS_ACCOUNT_PROFILE_PHOTO,
117         ACTIVATE_OS_ACCOUNT,
118         START_OS_ACCOUNT,
119         STOP_OS_ACCOUNT,
120         SUBSCRIBE_ACCOUNT,
121         UNSUBSCRIBE_ACCOUNT,
122         GET_OS_ACCOUNT_LOCAL_ID_FOR_SERIAL_NUMBER,
123         GET_SERIAL_NUMBER_FOR_OS_ACCOUNT,
124         GET_OS_ACCOUNT_SWITCH_MOD,
125         IS_CURRENT_OS_ACCOUNT_VERIFIED,
126         IS_OS_ACCOUNT_COMPLETED,
127         SET_CURRENT_OS_ACCOUNT_IS_VERIFIED,
128         SET_OS_ACCOUNT_IS_VERIFIED,
129         DUMP_STATE,
130         GET_CREATED_OS_ACCOUNT_NUM_FROM_DATABASE,
131         GET_SERIAL_NUM_FROM_DATABASE,
132         GET_MAX_ALLOW_CREATE_ID_FROM_DATABASE,
133         GET_OS_ACCOUNT_FROM_DATABASE,
134         GET_OS_ACCOUNT_LIST_FROM_DATABASE,
135         QUERY_ACTIVE_OS_ACCOUNT_IDS,
136         QUERY_OS_ACCOUNT_CONSTRAINT_SOURCE_TYPES,
137         SET_GLOBAL_OS_ACCOUNT_CONSTRAINTS,
138         SET_SPECIFIC_OS_ACCOUNT_CONSTRAINTS,
139     };
140 };
141 }  // namespace AccountSA
142 }  // namespace OHOS
143 
144 #endif  // OS_ACCOUNT_FRAMEWORK_OSACCOUNT_CORE_INCLUDE_IOS_ACCOUNT_H
145