IntentServerHandler QML Type
A handler for intent requests received within the System UI. More...
| Import Statement: | import QtApplicationManager.SystemUI 2.0 |
Properties
- categories : list<string>
- descriptions : object
- icon : url
- intentIds : list<string>
- names : object
- parameterMatch : object
- requiredCapabilities : list<string>
- visibility : enum
Signals
- requestReceived(IntentRequest request)
Detailed Description
If intents need to be handled from within the System UI, you need to have a corresponding IntentServerHandler instance that is actually able to handle incoming requests. This class gives you the flexibility to handle multiple, different intent ids via a single IntentServerHandler instance or have a dedicated IntentServerHandler instance for every intent id (or any combination of those).
Note: For handling intent requests within an application, you have to use the application side component IntentHandler, which works the same way, but provides all the necessary meta-data in the application's info.yaml manifest file.
For more information see IntentHandler and the description of the meta-data in the manifest documentation.
Callbacks connected to the onRequestReceived signal have access to the sender's application ID. Due to security restrictions, this is not the case for such handlers implemented in an application context via IntentHandler.
Property Documentation
The intent's categories. This corresponds to the categories field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
descriptions : object |
An object with all the language code to localized description mappings for this intent. This corresponds to the description field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
icon : url |
The intent's icon. This corresponds to the icon field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
Every handler needs to register at least one unique intent id that it will handle. Having multiple IntentServerHandlers that are registering the same intent id is not possible.
Note: Any changes to this property after component completion will have no effect.
names : object |
An object with all the language code to localized name mappings for this intent. This corresponds to the name field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
parameterMatch : object |
The intent's parameter requirements. This corresponds to the parameterMatch field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
The intent's required capabilities. This corresponds to the requiredCapabilities field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
visibility : enum |
The intent's visibility. Can be either IntentObject.Public (the default) or IntentObject.Private. This corresponds to the visibility field in the manifest documentation.
Note: Any changes to this property after component completion will have no effect.
Signal Documentation
requestReceived(IntentRequest request) |
This signal will be emitted once for every incoming intent request that this handler was registered for via its intentIds property.
For details, please see the IntentHandler::requestReceived documentation.
Note: The corresponding handler is onRequestReceived.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
