IntentRequest QML 类型

每个实例表示一个出去或进来的意图请求。更多信息...

导入语句	import QtApplicationManager 2.0

所有成员的列表，包括继承的成员

属性

applicationId : string
direction : IntentRequest::Direction
errorMessage : string
intentId : string
parameters : var
requestId : uuid
requestingApplicationId : string
result : var
succeeded : bool

信号

replyReceived()

方法

sendErrorReply(string errorMessage)
sendReply(var result)

详细描述

此类用于在应用程序和系统 UI 中表示意图请求。此类不能直接实例化，将由 IntentClient::sendIntentRequest() (用于向系统发出请求) 和 IntentHandler::requestReceived() (用于处理应用接收到的请求) 返回

请参阅 IntentClient 类型，了解如何向系统发送意图请求的简短示例。

IntentHandler 文档提供了一个示例，说明了当从系统接收请求时使用此类型的方法。

属性文档

[只读] applicationId : string

应处理此请求的应用程序的 ID。如果未请求特定应用程序，返回空字符串。

注意：常量，在发送和接收请求上均有效。

[只读] direction : IntentRequest::Direction

此属性描述该实例是出去或进来的意图请求

IntentRequest.ToSystem - 请求对象由 IntentClient::sendIntentRequest() 生成，即此请求已发送到系统端以进行处理。
IntentRequest.ToApplication - 请求对象由 IntentHandler::requestReceived() 接收，即此请求已从系统端发送到应用程序以进行处理。

注意：常量，在发送和接收请求上均有效。

[只读] errorMessage : string

一旦发出 replyReceived() 信号，此属性将保留请求失败时的潜在错误消息。

注意：仅在发送请求时有效。

另请参阅：succeeded。

[只读] intentId : 字符串

请求的意图ID。

注意：常量，在发送和接收请求上均有效。

[只读] parameters : var

作为JavaScript对象附加到请求的所有参数。

注意：常量，在发送和接收请求上均有效。

[只读] requestId : uuid

系统中的每个意图请求都会由服务器分配一个唯一的requestId，该ID将在整个请求的生命周期中用于每个上下文（请求应用程序、处理应用程序和意图服务器）。

注意：由于此requestId是由服务器生成的，因此由IntentClient::sendIntentRequest()生成的任何IntentRequest对象都将开始于一个null requestId。只有当服务器为传入的请求分配了新的requestId后，该属性才会异步更新。

注意：收到的请求的常量，对发送和接收请求都有效。

[只读] requestingApplicationId : 字符串

创建此意图请求的应用程序的ID。如果从应用程序上下文调用，将返回空字符串 - 只有服务器端在IntentServerHandler::requestReceived中可以访问此信息。

注意：常量，在发送和接收请求上均有效。

[只读] result : var

一旦replyReceived()信号发出，如果请求成功，则此属性将保持JavaScript对象格式的结果。

注意：仅在发送请求时有效。

另请参阅：succeeded。

[只读] succeeded : 布尔

一旦replyReceived()信号发出，此属性将显示意图请求是否实际上成功。

注意：仅在发送请求时有效。

信号文档

replyReceived()

当Intent请求的响应可用时发出此信号。信号处理程序需要检查succeeded属性以确定errorMessage或result是否真正有效。

注意：此信号只会为IntentClient::sendIntentRequest()创建的请求对象发出。

注意：相应的事件处理程序是onReplyReceived。

方法文档

sendErrorReply(字符串 errorMessage)

IntentHandlers可以使用此函数来表示它们无法处理通过IntentHandler::requestReceived()收到的请求，在errorMessage中说明原因。

一次只能使用sendReply()或sendErrorReply()来使用单个IntentRequest。

注意：此函数仅适用于从IntentHandler::requestReceived()收到的请求对象。它不会对由IntentClient::sendIntentRequest()创建的请求执行任何操作。

另请参阅 sendReply。

sendReply(var result)

IntentHandler（意图处理程序）需要调用此函数来将它的 result 发送回系统，作为对通过 IntentHandler::requestReceived() 接收到的请求的响应。

单个 IntentRequest 上只能使用 sendReply() 或 sendErrorReply() 中的一个。

注意：此函数仅适用于从IntentHandler::requestReceived()收到的请求对象。它不会对由IntentClient::sendIntentRequest()创建的请求执行任何操作。

另请参阅 sendErrorReply。