• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2024 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 OHOS_ABILITY_RUNTIME_KEEP_ALIVE_INFO_H
17 #define OHOS_ABILITY_RUNTIME_KEEP_ALIVE_INFO_H
18 
19 #include <string>
20 
21 #include "parcel.h"
22 
23 namespace OHOS {
24 namespace AbilityRuntime {
25 /**
26  * @class KeepAliveSetter
27  * defines who sets the keep-alive flag for apps.
28  */
29 enum class KeepAliveSetter : int32_t {
30     UNSPECIFIED = -1,
31     SYSTEM = 0,
32     USER = 1,
33 };
34 
35 /**
36  * @class KeepAliveAppType
37  * defines the app type.
38  */
39 enum class KeepAliveAppType : int32_t {
40     UNSPECIFIED = 0,
41     THIRD_PARTY = 1,
42     SYSTEM = 2,
43 };
44 
45 /**
46  * @class KeepAlivePolicy
47  * defines the keep-alive policy.
48  */
49 enum class KeepAlivePolicy : int32_t {
50     UNSPECIFIED = 0,
51     NOT_ALLOW_CANCEL = 1,
52     ALLOW_CANCEL = 2,
53 };
54 
55 /**
56  * @struct KeepAliveInfo
57  * Defines keep-alive info.
58  */
59 struct KeepAliveInfo : public Parcelable {
60 public:
61     int32_t userId = -1;
62     int32_t setterId = -1;
63     KeepAliveAppType appType = KeepAliveAppType::UNSPECIFIED;
64     KeepAliveSetter setter = KeepAliveSetter::UNSPECIFIED;
65     KeepAlivePolicy policy = KeepAlivePolicy::UNSPECIFIED;
66     std::string bundleName;
67 
68     bool ReadFromParcel(Parcel &parcel);
69     virtual bool Marshalling(Parcel &parcel) const override;
70     static KeepAliveInfo *Unmarshalling(Parcel &parcel);
71 };
72 
73 struct KeepAliveStatus {
74     int32_t code;
75     int32_t setterId;
76     KeepAliveSetter setter;
77     KeepAlivePolicy policy = KeepAlivePolicy::UNSPECIFIED;
78 };
79 } // namespace AbilityRuntime
80 } // namespace OHOS
81 #endif // OHOS_ABILITY_RUNTIME_KEEP_ALIVE_INFO_H