This service provides information about the current configuration and state of the UserManager More...
#include <IStatusInfoService.hpp>
Inheritance diagram for Arp::System::Um::Services::IStatusInfoService:
Public Types | |
| using | Ptr = std::shared_ptr< IStatusInfoService > |
 Public Types inherited from Arp::Base::Rsc::Commons::IRscService | |
| using | Ptr = std::shared_ptr< IRscService > |
| The shared_ptr type of IRscService. | |
Public Member Functions | |
| IStatusInfoService (void)=default | |
| Constructs an IStatusInfoService instance. | |
| virtual std::vector< RscString< 64 > > | ListAllKnownRoles ()=0 |
| This operation retrieves the names of all roles currently known to the UserManager More... | |
| virtual std::vector< RscString< 64 > > | ListRolesOfCurrentSession ()=0 |
| This operation retrieves the names of all roles for this session More... | |
| Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService | |
| IRscService (void)=default | |
| The default constructor. | |
| IRscService (const IRscService &arg)=delete | |
| The deleted copy constructor. More... | |
| IRscService (IRscService &&arg) noexcept=default | |
| The default move constructor. More... | |
| IRscService & | operator= (const IRscService &arg)=delete |
| The deleted assignment operator. More... | |
| IRscService & | operator= (IRscService &&arg) noexcept=default |
| The default move-assignment operator. More... | |
| virtual | ~IRscService (void)=default |
| Destructs this instance and frees all resources. | |
Static Public Member Functions | |
| static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService | |
| static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Returns a reference to service proxy factory to create a proxy instance of this service. More... | |
Detailed Description
This service provides information about the current configuration and state of the UserManager
Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.
Member Function Documentation
◆ ListAllKnownRoles()
|
pure virtual |
This operation retrieves the names of all roles currently known to the UserManager
- Returns
- Returns a list of strings with all roles known to the UserManager. Returns an empty List on error
◆ ListRolesOfCurrentSession()
|
pure virtual |
This operation retrieves the names of all roles for this session
- Returns
- Returns a list of strings with all roles assigned to the current session. Returns an empty List on error
The documentation for this class was generated from the following file:
- Arp/System/Um/Services/IStatusInfoService.hpp
