PLCnext API Documentation 26.6.0.38
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
21{
22
23using namespace Arp::Base::Rsc::Commons;
24
125class ARP_EXPORT IAppManagerService : public IRscService
126{
127public: // usings
128 using Ptr = std::shared_ptr<IAppManagerService>;
129
130public: // construction/destruction
132 IAppManagerService(void) = default;
133
134public: // static policy operation
135 static IRscServiceProxyFactory& GetProxyFactory(void);
136
137public: // abstract operations
147 virtual AppManagerServiceError ListInstalledApps(std::vector<AppInfo>& list) = 0;
148
202 virtual AppManagerServiceError InstallApp(const RscString<512>& filename, const RscString<256>& appIdentifier = "") = 0;
203
252 virtual AppManagerServiceError UnInstallApp(const RscString<256>& appIdentifier) = 0;
253
308 virtual AppManagerServiceError StartApp(const RscString<256>& appIdentifier) = 0;
309
359 virtual AppManagerServiceError StopApp(const RscString<256>& appIdentifier) = 0;
360
374 virtual AppManagerServiceError GetAppStatus(const RscString<256>& appIdentifier, AppStatus& status) = 0;
375
389 virtual AppManagerServiceError GetAppsStatus(const std::vector<RscString<256>>& appIdentifiers, std::vector<AppStatus>& status) = 0;
390
398 virtual AppManagerServiceError GetAppInfo(const RscString<256>& appIdentifier, AppInfo& appInfo) = 0;
399
417 virtual AppManagerServiceError GetExtendedAppInfo(const RscString<256>& appIdentifier, const RscString<256>& extendedInfoKey, RscVariant<256>& infoItem) = 0;
418
432
453
470 virtual AppManagerServiceError DisableInstallationMode(boolean autoRestartDisabled = false) = 0;
471
489};
490
491} // 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:126
virtual AppManagerServiceError DisableInstallationMode(boolean autoRestartDisabled=false)=0
Disables the installation mode of the App Manager. If a reboot is required by previous install/start/...
IAppManagerService(void)=default
Constructs an IAppManagerService instance.
virtual AppManagerServiceError UnInstallApp(const RscString< 256 > &appIdentifier)=0
Uninstalls an app specified by its identifier.
virtual AppManagerServiceError GetAppsStatus(const std::vector< RscString< 256 > > &appIdentifiers, std::vector< AppStatus > &status)=0
Reads the statuses of apps specified by appIdentifiers . If an identifier no longer exists,...
virtual AppManagerServiceError EnableInstallationMode(const RscString< 256 > &callerName)=0
Enables the installation mode of the App Manager using the specified user name. Only with active inst...
virtual AppManagerServiceError GetExtendedAppInfo(const RscString< 256 > &appIdentifier, const RscString< 256 > &extendedInfoKey, RscVariant< 256 > &infoItem)=0
Retrieves extended information for the specified application based on the provided key.
virtual AppManagerServiceError StartApp(const RscString< 256 > &appIdentifier)=0
Starts the PLCnext application specified by appIdentifier . The app may start asynchronously; during ...
virtual AppManagerServiceError ListInstalledApps(std::vector< AppInfo > &list)=0
Lists all installed PLCnext Technology Apps by their identifier.
virtual AppManagerServiceError InstallApp(const RscString< 512 > &filename, const RscString< 256 > &appIdentifier="")=0
Installs a PLCnext Technology App from an app container file located on the controller (path specifie...
virtual AppManagerServiceError GetAppStatus(const RscString< 256 > &appIdentifier, AppStatus &status)=0
Reads the status of the app specified by appIdentifier .
virtual AppManagerServiceError GetExtendedAppManagerInfo(const RscString< 256 > &extendedInfoKey, RscVariant< 256 > &infoItem)=0
Retrieves extended App Manager information based on the provided key.
virtual AppManagerServiceError GetAppInfo(const RscString< 256 > &appIdentifier, AppInfo &appInfo)=0
Reads the app information for the app specified by appIdentifier .
virtual AppManagerStatus GetAppManagerStatus()=0
Reads the status of the App Manager.
virtual AppManagerServiceError StopApp(const RscString< 256 > &appIdentifier)=0
Stops the PLCnext application specified by appIdentifier . The app may stop asynchronously; during sh...
Namespace for services of the AppManager
AppManagerStatus
Bit field that indicates the App Manager state and related flags.
Definition: AppManagerStatus.hpp:30
AppStatus
Bit field that indicates the status of a PLCnext application and related flags.
Definition: AppStatus.hpp:31