• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021 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 FOUNDATION_APPEXECFWK_SERVICES_BUNDLEMGR_INCLUDE_SYSTEM_ABILITY_HELPER_H
17 #define FOUNDATION_APPEXECFWK_SERVICES_BUNDLEMGR_INCLUDE_SYSTEM_ABILITY_HELPER_H
18 
19 #include <string>
20 
21 #include "iremote_object.h"
22 
23 namespace OHOS {
24 namespace AppExecFwk {
25 
26 class SystemAbilityHelper {
27 public:
28     /**
29      * @brief Get a pointer to a IRemoteObject object from system ability service.
30      * @param systemAbilityId Indicates the system ability ID to be got.
31      * @return Returns a pointer to the IRemoteObject object.
32      */
33     static sptr<IRemoteObject> GetSystemAbility(const int32_t systemAbilityId);
34     /**
35      * @brief Register a service to the system ability service.
36      * @param systemAbilityId Indicates the system ability ID to be registered.
37      * @param systemAbility Indicates the IRemoteObject pointer to be registered.
38      * @return Returns true if the pointer registered successfully; returns false otherwise.
39      */
40     static bool AddSystemAbility(const int32_t systemAbilityId, const sptr<IRemoteObject> &systemAbility);
41     /**
42      * @brief Unregister a service from the system ability service.
43      * @param systemAbilityId Indicates the system ability ID to be unregistered.
44      * @return Returns true if the service unregistered successfully; returns false otherwise.
45      */
46     static bool RemoveSystemAbility(const int32_t systemAbilityId);
47 };
48 
49 }  // namespace AppExecFwk
50 }  // namespace OHOS
51 #endif  // FOUNDATION_APPEXECFWK_SERVICES_BUNDLEMGR_INCLUDE_SYSTEM_ABILITY_HELPER_H