1 /*
2  * Copyright (c) 2021-2023 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_MISSION_LISTENER_PROXY_H
17 #define OHOS_ABILITY_RUNTIME_MISSION_LISTENER_PROXY_H
18 
19 #include <string>
20 #include "iremote_proxy.h"
21 #include "mission_listener_interface.h"
22 
23 namespace OHOS {
24 namespace AAFwk {
25 /**
26  * interface for mission listener.
27  */
28 class MissionListenerProxy : public IRemoteProxy<IMissionListener> {
29 public:
MissionListenerProxy(const sptr<IRemoteObject> & impl)30     explicit MissionListenerProxy(const sptr<IRemoteObject> &impl) : IRemoteProxy<IMissionListener>(impl)
31     {}
32 
33     /**
34      * @brief Sends OnMissionCreated request.
35      *
36      * @param missionId Indicators id of mission.
37      */
38     virtual void OnMissionCreated(int32_t missionId) override;
39 
40     /**
41      * @brief Sends OnMissionDestroyed request.
42      *
43      * @param missionId Indicators id of mission.
44      */
45     virtual void OnMissionDestroyed(int32_t missionId) override;
46 
47     /**
48      * @brief Sends OnMissionSnapshotChanged request.
49      *
50      * @param missionId Indicators id of mission.
51      */
52     virtual void OnMissionSnapshotChanged(int32_t missionId) override;
53 
54     /**
55      * @brief Sends OnMissionMovedToFront request.
56      *
57      * @param missionId Indicators id of mission.
58      */
59     virtual void OnMissionMovedToFront(int32_t missionId) override;
60 
61     /**
62      * @brief Sends OnMissionFocused request.
63      *
64      * @param missionId Indicators id of mission.
65      */
66     virtual void OnMissionFocused(int32_t missionId) override;
67 
68     /**
69      * @brief Sends OnMissionUnfocused request.
70      *
71      * @param missionId Indicators id of mission.
72      */
73     virtual void OnMissionUnfocused(int32_t missionId) override;
74 
75 #ifdef SUPPORT_GRAPHICS
76     /**
77      * @brief Called when a mission has changed it's icon.
78      *
79      * @param missionId, mission Id.
80      * @param icon, mission icon.
81      */
82     virtual void OnMissionIconUpdated(int32_t missionId, const std::shared_ptr<OHOS::Media::PixelMap> &icon) override;
83 #endif
84 
85     /**
86      * @brief When a mission is closed, AbilityMs notifies the listener of the mission id
87      *
88      * @param missionId, mission Id.
89      */
90     virtual void OnMissionClosed(int32_t missionId) override;
91 
92     /**
93      * @brief When a mission's label was changed, AbilityMs notifies the listener of the mission id
94      *
95      * @param missionId, mission Id.
96      */
97     virtual void OnMissionLabelUpdated(int32_t missionId) override;
98 
99 private:
100     void SendRequestCommon(int32_t missionId, IMissionListener::MissionListenerCmd cmd);
101 
102 private:
103     static inline BrokerDelegator<MissionListenerProxy> delegator_;
104 };
105 }  // namespace AAFwk
106 }  // namespace OHOS
107 #endif  // OHOS_ABILITY_RUNTIME_MISSION_LISTENER_PROXY_H
108