PLCnext API Documentation 25.0.2.69
IAppManagerService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include <vector>
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12#include "Arp/Base/Rsc/Commons/RscVariant.hxx"
13#include "Arp/Services/AppManager/Services/AppInfo.hpp"
14#include "Arp/Services/AppManager/Services/AppManagerServiceError.hpp"
15#include "Arp/Services/AppManager/Services/AppManagerStatus.hpp"
16#include "Arp/Services/AppManager/Services/AppStatus.hpp"
17
18// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IAppManagerService.cs
19
20namespace Arp::Services::AppManager::Services
21{
22
23using namespace Arp::Base::Rsc::Commons;
24
35class ARP_EXPORT IAppManagerService : public IRscService
36{
37public: // usings
38 using Ptr = std::shared_ptr<IAppManagerService>;
39
40public: // construction/destruction
42 IAppManagerService(void) = default;
43
44public: // static policy operation
45 static IRscServiceProxyFactory& GetProxyFactory(void);
46
47public: // abstract operations
60 virtual AppManagerServiceError ListInstalledApps(std::vector<AppInfo>& list) = 0;
61
81 virtual AppManagerServiceError InstallApp(const RscString<512>& filename, const RscString<256>& appIdentifier = "") = 0;
82
95 virtual AppManagerServiceError UnInstallApp(const RscString<256>& appIdentifier) = 0;
96
111 virtual AppManagerServiceError StartApp(const RscString<256>& appIdentifier) = 0;
112
127 virtual AppManagerServiceError StopApp(const RscString<256>& appIdentifier) = 0;
128
144 virtual AppManagerServiceError GetAppStatus(const RscString<256>& appIdentifier, AppStatus& status) = 0;
145
162 virtual AppManagerServiceError GetAppsStatus(const std::vector<RscString<256>>& appIdentifiers, std::vector<AppStatus>& status) = 0;
163
180 virtual AppManagerServiceError GetAppInfo(const RscString<256>& appIdentifier, AppInfo& appInfo) = 0;
181
191 virtual AppManagerServiceError GetExtendedAppInfo(const RscString<256>& appIdentifier, const RscString<256>& extendedInfoKey, RscVariant<256>& data) = 0;
192
199 virtual AppManagerStatus GetAppManagerStatus() = 0;
200
218
234 virtual AppManagerServiceError DisableInstallationMode(boolean autoRestartDisabled = false) = 0;
235};
236
237} // end of namespace Arp::Services::AppManager::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This structure is used for PLCnext application information indication.
Definition: AppInfo.hpp:30
This struct is used for error codes of the IAppManagerService
Definition: AppManagerServiceError.hpp:28
This services represents the RSC-Interface for the AppManager service component
Definition: IAppManagerService.hpp:36
virtual AppManagerServiceError DisableInstallationMode(boolean autoRestartDisabled=false)=0
Disables the installation mode of the appManager If a reboot is required by previous installations,...
virtual AppManagerServiceError GetExtendedAppInfo(const RscString< 256 > &appIdentifier, const RscString< 256 > &extendedInfoKey, RscVariant< 256 > &data)=0
Retrieves extended information for the specified application based on the provided key.
IAppManagerService(void)=default
Constructs an IAppManagerService instance.
virtual AppManagerServiceError UnInstallApp(const RscString< 256 > &appIdentifier)=0
Uninstall an app that is specified by the app identifier.
virtual AppManagerServiceError GetAppsStatus(const std::vector< RscString< 256 > > &appIdentifiers, std::vector< AppStatus > &status)=0
Reads out the application status of the applications that are specified by the app identifiers....
virtual AppManagerServiceError EnableInstallationMode(const RscString< 256 > &callerName)=0
Enabled the installation mode of the AppManager using the specified user name. Only with active insta...
virtual AppManagerServiceError StartApp(const RscString< 256 > &appIdentifier)=0
Starts the PLCnext application that is specified by the app identifier. The app can also start asynch...
virtual AppManagerServiceError ListInstalledApps(std::vector< AppInfo > &list)=0
Lists all installed PLCnext applications by their identifier.
virtual AppManagerServiceError InstallApp(const RscString< 512 > &filename, const RscString< 256 > &appIdentifier="")=0
The method InstallApp installs an app from an app container that is located on the controller and is ...
virtual AppManagerServiceError GetAppStatus(const RscString< 256 > &appIdentifier, AppStatus &status)=0
Reads out the app status of an app that is specified by the app identifier.
virtual AppManagerServiceError GetAppInfo(const RscString< 256 > &appIdentifier, AppInfo &appInfo)=0
Reads out the app infos of an app that is specified by the app identifier.
virtual AppManagerStatus GetAppManagerStatus()=0
Reads out the status of the app manager.
virtual AppManagerServiceError StopApp(const RscString< 256 > &appIdentifier)=0
Stops the PLCnext application that is specified by the app identifier. The app can also stop asynchro...