mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
backgroundkit wantAgent元服务标签补充
Signed-off-by: tangjie <1402602435@qq.com>
This commit is contained in:
tangjie
parent
e5e3cb803e
commit
1dfa27fdee
366
api/@ohos.app.ability.wantAgent.d.ts
vendored
366
api/@ohos.app.ability.wantAgent.d.ts
vendored
@ -31,6 +31,15 @@ import { TriggerInfo as _TriggerInfo } from './wantAgent/triggerInfo';
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Provide the method obtain trigger, cancel, and compare and to obtain
|
||||
* the bundle name, UID of an {@link WantAgent} object.
|
||||
*
|
||||
* @namespace wantAgent
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
declare namespace wantAgent {
|
||||
/**
|
||||
* Obtains the bundle name of a WantAgent.
|
||||
@ -44,6 +53,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains the bundle name of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { AsyncCallback<string> } callback - The callback is used to return the bundle name.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getBundleName(agent: WantAgent, callback: AsyncCallback<string>): void;
|
||||
|
||||
/**
|
||||
@ -58,6 +80,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains the bundle name of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @returns { Promise<string> } Returns the bundle name.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getBundleName(agent: WantAgent): Promise<string>;
|
||||
|
||||
/**
|
||||
@ -72,6 +107,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains the UID of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the UID.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getUid(agent: WantAgent, callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
@ -86,6 +134,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains the UID of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @returns { Promise<number> } Returns the UID.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getUid(agent: WantAgent): Promise<number>;
|
||||
|
||||
/**
|
||||
@ -132,6 +193,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Cancel a WantAgent. Only the application that creates the WantAgent can cancel it.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { AsyncCallback<void> } callback - The callback of cancel.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function cancel(agent: WantAgent, callback: AsyncCallback<void>): void;
|
||||
|
||||
/**
|
||||
@ -146,6 +220,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Cancel a WantAgent. Only the application that creates the WantAgent can cancel it.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @returns { Promise<void> } The promise returned by the function.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function cancel(agent: WantAgent): Promise<void>;
|
||||
|
||||
/**
|
||||
@ -159,6 +246,18 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Triggers a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { TriggerInfo } triggerInfo - Indicates the information required for triggering a WantAgent.
|
||||
* @param { AsyncCallback<CompleteData> } [callback] - The callback is used to return the CompleteData.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback<CompleteData>): void;
|
||||
|
||||
/**
|
||||
@ -172,6 +271,18 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Checks whether two WantAgent objects are equal.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { WantAgent } otherAgent - Indicates the other WantAgent.
|
||||
* @param { AsyncCallback<boolean> } callback - Returns true if the two WantAgents are the same.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>): void;
|
||||
|
||||
/**
|
||||
@ -185,6 +296,18 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Checks whether two WantAgent objects are equal.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { WantAgent } otherAgent - Indicates the other WantAgent.
|
||||
* @returns { Promise<boolean> } Returns true if the two WantAgents are the same.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function equal(agent: WantAgent, otherAgent: WantAgent): Promise<boolean>;
|
||||
|
||||
/**
|
||||
@ -199,6 +322,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains a WantAgent object.
|
||||
*
|
||||
* @param { WantAgentInfo } info - Information about the WantAgent object to obtain.
|
||||
* @param { AsyncCallback<WantAgent> } callback - The callback is used to return the created WantAgent.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>): void;
|
||||
|
||||
/**
|
||||
@ -213,6 +349,19 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains a WantAgent object.
|
||||
*
|
||||
* @param { WantAgentInfo } info - Information about the WantAgent object to obtain.
|
||||
* @returns { Promise<WantAgent> } Returns the created WantAgent.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getWantAgent(info: WantAgentInfo): Promise<WantAgent>;
|
||||
|
||||
/**
|
||||
@ -228,6 +377,20 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains the {@link OperationType} of a {@link WantAgent}.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @param { AsyncCallback<number> } callback - The callback is used to return the OperationType of the WantAgent.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000015 - Service timeout.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getOperationType(agent: WantAgent, callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
@ -243,6 +406,20 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains the {@link OperationType} of a {@link WantAgent}.
|
||||
*
|
||||
* @param { WantAgent } agent - Indicates the WantAgent.
|
||||
* @returns { Promise<number> } Returns the OperationType of the WantAgent.
|
||||
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
||||
* 2. Incorrect parameter types.
|
||||
* @throws { BusinessError } 16000007 - Service busy, there are concurrent tasks, waiting for retry.
|
||||
* @throws { BusinessError } 16000015 - Service timeout.
|
||||
* @throws { BusinessError } 16000151 - Invalid wantagent object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
function getOperationType(agent: WantAgent): Promise<number>;
|
||||
|
||||
/**
|
||||
@ -252,6 +429,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Enumerates flags for using a WantAgent.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export enum WantAgentFlags {
|
||||
/**
|
||||
* Indicates that the WantAgent can be used only once.
|
||||
@ -260,6 +445,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the WantAgent can be used only once.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
ONE_TIME_FLAG = 0,
|
||||
|
||||
/**
|
||||
@ -269,6 +462,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that null is returned if the WantAgent does not exist.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
NO_BUILD_FLAG,
|
||||
|
||||
/**
|
||||
@ -278,6 +479,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the existing WantAgent should be canceled before a new object is generated.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
CANCEL_PRESENT_FLAG,
|
||||
|
||||
/**
|
||||
@ -287,6 +496,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the system only replaces the extra data of the existing WantAgent with that of the new object.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
UPDATE_PRESENT_FLAG,
|
||||
|
||||
/**
|
||||
@ -295,6 +512,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the created WantAgent should be immutable.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
CONSTANT_FLAG,
|
||||
|
||||
/**
|
||||
@ -303,6 +527,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of element can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
REPLACE_ELEMENT,
|
||||
|
||||
/**
|
||||
@ -311,6 +542,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of action can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
REPLACE_ACTION,
|
||||
|
||||
/**
|
||||
@ -319,6 +557,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of uri can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
REPLACE_URI,
|
||||
|
||||
/**
|
||||
@ -327,6 +572,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of entities can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
REPLACE_ENTITIES,
|
||||
|
||||
/**
|
||||
@ -335,6 +587,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of packageName can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
REPLACE_BUNDLE
|
||||
}
|
||||
|
||||
@ -345,6 +604,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Identifies the operation for using a WantAgent, such as starting an ability or sending a common event.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export enum OperationType {
|
||||
/**
|
||||
* Unknown operation.
|
||||
@ -352,6 +619,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Unknown operation.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
UNKNOWN_TYPE = 0,
|
||||
|
||||
/**
|
||||
@ -360,6 +634,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Starts an ability with a UI.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
START_ABILITY,
|
||||
|
||||
/**
|
||||
@ -368,6 +649,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Starts multiple abilities with a UI.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
START_ABILITIES,
|
||||
|
||||
/**
|
||||
@ -376,6 +664,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Starts an ability without a UI.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
START_SERVICE,
|
||||
|
||||
/**
|
||||
@ -384,6 +679,13 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Sends a common event.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
SEND_COMMON_EVENT,
|
||||
|
||||
/**
|
||||
@ -404,6 +706,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Describes the data returned by after wantAgent.trigger is called.
|
||||
*
|
||||
* @typedef CompleteData
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export interface CompleteData {
|
||||
/**
|
||||
* Triggered WantAgent.
|
||||
@ -412,6 +722,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Triggered WantAgent.
|
||||
*
|
||||
* @type { WantAgent }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
info: WantAgent;
|
||||
|
||||
/**
|
||||
@ -421,6 +739,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Existing Want that is triggered.
|
||||
*
|
||||
* @type { Want }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
want: Want;
|
||||
|
||||
/**
|
||||
@ -430,6 +756,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Request code used to trigger the WantAgent.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
finalCode: number;
|
||||
|
||||
/**
|
||||
@ -439,6 +773,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Final data collected by the common event.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
finalData: string;
|
||||
|
||||
/**
|
||||
@ -455,6 +797,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Extra data collected by the common event.
|
||||
*
|
||||
* @type { ?Record<string, Object> }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
extraInfo?: Record<string, Object>;
|
||||
}
|
||||
|
||||
@ -465,6 +815,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Provides the information required for triggering a WantAgent.
|
||||
*
|
||||
* @typedef { _TriggerInfo }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export type TriggerInfo = _TriggerInfo;
|
||||
|
||||
/**
|
||||
@ -474,6 +832,14 @@ declare namespace wantAgent {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Provides the information required for triggering a WantAgent.
|
||||
*
|
||||
* @typedef { _WantAgentInfo }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export type WantAgentInfo = _WantAgentInfo;
|
||||
}
|
||||
|
||||
|
||||
356
api/@ohos.wantAgent.d.ts
vendored
356
api/@ohos.wantAgent.d.ts
vendored
@ -32,6 +32,17 @@ import { TriggerInfo } from './wantAgent/triggerInfo';
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent
|
||||
*/
|
||||
/**
|
||||
* Provide the method obtain trigger, cancel, and compare and to obtain
|
||||
* the bundle name, UID of an {@link WantAgent} object.
|
||||
*
|
||||
* @namespace wantAgent
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent
|
||||
*/
|
||||
declare namespace wantAgent {
|
||||
/**
|
||||
* Obtains the bundle name of a WantAgent.
|
||||
@ -43,6 +54,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getBundleName
|
||||
*/
|
||||
/**
|
||||
* Obtains the bundle name of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - whose bundle name to obtain.
|
||||
* @param { AsyncCallback<string> } callback - A callback method to obtain the package name of the WantAgent instance.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getBundleName
|
||||
*/
|
||||
function getBundleName(agent: WantAgent, callback: AsyncCallback<string>): void;
|
||||
|
||||
/**
|
||||
@ -55,6 +77,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getBundleName
|
||||
*/
|
||||
/**
|
||||
* Obtains the bundle name of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - whose bundle name to obtain.
|
||||
* @returns { Promise<string> } Returns the bundle name of the {@link WantAgent} if any.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getBundleName
|
||||
*/
|
||||
function getBundleName(agent: WantAgent): Promise<string>;
|
||||
|
||||
/**
|
||||
@ -67,6 +100,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getUid
|
||||
*/
|
||||
/**
|
||||
* Obtains the UID of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - whose UID to obtain.
|
||||
* @param { AsyncCallback<number> } callback - Create a callback method for WantAgent.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getUid
|
||||
*/
|
||||
function getUid(agent: WantAgent, callback: AsyncCallback<number>): void;
|
||||
|
||||
/**
|
||||
@ -79,6 +123,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getUid
|
||||
*/
|
||||
/**
|
||||
* Obtains the UID of a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - whose UID to obtain.
|
||||
* @returns { Promise<number> } Returns the UID of the {@link WantAgent} if any; returns {@code -1} otherwise.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getUid
|
||||
*/
|
||||
function getUid(agent: WantAgent): Promise<number>;
|
||||
|
||||
/**
|
||||
@ -117,6 +172,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#cancel
|
||||
*/
|
||||
/**
|
||||
* Cancel a WantAgent. Only the application that creates the WantAgent can cancel it.
|
||||
*
|
||||
* @param { WantAgent } agent - to cancel.
|
||||
* @param { AsyncCallback<void> } callback - Cancel the callback method for Want in WantAgent.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#cancel
|
||||
*/
|
||||
function cancel(agent: WantAgent, callback: AsyncCallback<void>): void;
|
||||
|
||||
/**
|
||||
@ -129,6 +195,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#cancel
|
||||
*/
|
||||
/**
|
||||
* Cancel a WantAgent. Only the application that creates the WantAgent can cancel it.
|
||||
*
|
||||
* @param { WantAgent } agent - to cancel.
|
||||
* @returns { Promise<void> } The promise returned by the function.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#cancel
|
||||
*/
|
||||
function cancel(agent: WantAgent): Promise<void>;
|
||||
|
||||
/**
|
||||
@ -143,6 +220,19 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#trigger
|
||||
*/
|
||||
/**
|
||||
* Triggers a WantAgent.
|
||||
*
|
||||
* @param { WantAgent } agent - to trigger.
|
||||
* @param { TriggerInfo } triggerInfo - parameters.
|
||||
* @param { Callback<CompleteData> } [callback] - Indicates the callback method to be called after
|
||||
* the {@link WantAgent} is triggered.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#trigger
|
||||
*/
|
||||
function trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>): void;
|
||||
|
||||
/**
|
||||
@ -157,6 +247,19 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#equal
|
||||
*/
|
||||
/**
|
||||
* Checks whether two WantAgent objects are equal.
|
||||
*
|
||||
* @param { WantAgent } agent - to compare.
|
||||
* @param { WantAgent } otherAgent - WantAgent Object.
|
||||
* @param { AsyncCallback<boolean> } callback - Callback method for determining whether two WantAgent instances are
|
||||
* equal.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#equal
|
||||
*/
|
||||
function equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>): void;
|
||||
|
||||
/**
|
||||
@ -170,6 +273,18 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#equal
|
||||
*/
|
||||
/**
|
||||
* Checks whether two WantAgent objects are equal.
|
||||
*
|
||||
* @param { WantAgent } agent - to compare.
|
||||
* @param { WantAgent } otherAgent - WantAgent Object.
|
||||
* @returns { Promise<boolean> } Returns {@code true} If the two objects are the same; returns {@code false} otherwise.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#equal
|
||||
*/
|
||||
function equal(agent: WantAgent, otherAgent: WantAgent): Promise<boolean>;
|
||||
|
||||
/**
|
||||
@ -182,6 +297,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getWantAgent
|
||||
*/
|
||||
/**
|
||||
* Obtains a WantAgent object.
|
||||
*
|
||||
* @param { WantAgentInfo } info - about the WantAgent object to obtain.
|
||||
* @param { AsyncCallback<WantAgent> } callback - Callback method for obtaining the user ID of WantAgent instance.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getWantAgent
|
||||
*/
|
||||
function getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>): void;
|
||||
|
||||
/**
|
||||
@ -194,6 +320,17 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getWantAgent
|
||||
*/
|
||||
/**
|
||||
* Obtains a WantAgent object.
|
||||
*
|
||||
* @param { WantAgentInfo } info - about the WantAgent object to obtain.
|
||||
* @returns { Promise<WantAgent> } Returns the created {@link WantAgent} object.
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#getWantAgent
|
||||
*/
|
||||
function getWantAgent(info: WantAgentInfo): Promise<WantAgent>;
|
||||
|
||||
/**
|
||||
@ -205,6 +342,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#WantAgentFlags
|
||||
*/
|
||||
/**
|
||||
* Enumerates flags for using a WantAgent.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#WantAgentFlags
|
||||
*/
|
||||
export enum WantAgentFlags {
|
||||
/**
|
||||
* Indicates that the WantAgent can be used only once.
|
||||
@ -215,6 +362,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#ONE_TIME_FLAG
|
||||
*/
|
||||
/**
|
||||
* Indicates that the WantAgent can be used only once.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#ONE_TIME_FLAG
|
||||
*/
|
||||
ONE_TIME_FLAG = 0,
|
||||
|
||||
/**
|
||||
@ -226,6 +383,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#NO_BUILD_FLAG
|
||||
*/
|
||||
/**
|
||||
* Indicates that null is returned if the WantAgent does not exist.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#NO_BUILD_FLAG
|
||||
*/
|
||||
NO_BUILD_FLAG,
|
||||
|
||||
/**
|
||||
@ -237,6 +404,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#CANCEL_PRESENT_FLAG
|
||||
*/
|
||||
/**
|
||||
* Indicates that the existing WantAgent should be canceled before a new object is generated.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#CANCEL_PRESENT_FLAG
|
||||
*/
|
||||
CANCEL_PRESENT_FLAG,
|
||||
|
||||
/**
|
||||
@ -248,6 +425,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#UPDATE_PRESENT_FLAG
|
||||
*/
|
||||
/**
|
||||
* Indicates that the system only replaces the extra data of the existing WantAgent with that of the new object.
|
||||
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#UPDATE_PRESENT_FLAG
|
||||
*/
|
||||
UPDATE_PRESENT_FLAG,
|
||||
|
||||
/**
|
||||
@ -258,6 +445,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#CONSTANT_FLAG
|
||||
*/
|
||||
/**
|
||||
* Indicates that the created WantAgent should be immutable.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#CONSTANT_FLAG
|
||||
*/
|
||||
CONSTANT_FLAG,
|
||||
|
||||
/**
|
||||
@ -268,6 +464,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_ELEMENT
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of element can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_ELEMENT
|
||||
*/
|
||||
REPLACE_ELEMENT,
|
||||
|
||||
/**
|
||||
@ -278,6 +483,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_ACTION
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of action can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_ACTION
|
||||
*/
|
||||
REPLACE_ACTION,
|
||||
|
||||
/**
|
||||
@ -288,6 +502,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_URI
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of uri can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_URI
|
||||
*/
|
||||
REPLACE_URI,
|
||||
|
||||
/**
|
||||
@ -298,6 +521,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_ENTITIES
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of entities can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_ENTITIES
|
||||
*/
|
||||
REPLACE_ENTITIES,
|
||||
|
||||
/**
|
||||
@ -308,6 +540,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_BUNDLE
|
||||
*/
|
||||
/**
|
||||
* Indicates that the current value of packageName can be replaced when the WantAgent is triggered.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.WantAgentFlags#REPLACE_BUNDLE
|
||||
*/
|
||||
REPLACE_BUNDLE
|
||||
}
|
||||
|
||||
@ -320,6 +561,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#OperationType
|
||||
*/
|
||||
/**
|
||||
* Identifies the operation for using a WantAgent, such as starting an ability or sending a common event.
|
||||
*
|
||||
* @enum { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#OperationType
|
||||
*/
|
||||
export enum OperationType {
|
||||
/**
|
||||
* Unknown operation.
|
||||
@ -329,6 +580,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#UNKNOWN_TYPE
|
||||
*/
|
||||
/**
|
||||
* Unknown operation.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#UNKNOWN_TYPE
|
||||
*/
|
||||
UNKNOWN_TYPE = 0,
|
||||
|
||||
/**
|
||||
@ -339,6 +599,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#START_ABILITY
|
||||
*/
|
||||
/**
|
||||
* Starts an ability with a UI.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#START_ABILITY
|
||||
*/
|
||||
START_ABILITY,
|
||||
|
||||
/**
|
||||
@ -349,6 +618,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#START_ABILITIES
|
||||
*/
|
||||
/**
|
||||
* Starts multiple abilities with a UI.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#START_ABILITIES
|
||||
*/
|
||||
START_ABILITIES,
|
||||
|
||||
/**
|
||||
@ -359,6 +637,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#START_SERVICE
|
||||
*/
|
||||
/**
|
||||
* Starts an ability without a UI.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#START_SERVICE
|
||||
*/
|
||||
START_SERVICE,
|
||||
|
||||
/**
|
||||
@ -369,6 +656,15 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#SEND_COMMON_EVENT
|
||||
*/
|
||||
/**
|
||||
* Sends a common event.
|
||||
*
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.OperationType#SEND_COMMON_EVENT
|
||||
*/
|
||||
SEND_COMMON_EVENT
|
||||
}
|
||||
|
||||
@ -381,6 +677,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#CompleteData
|
||||
*/
|
||||
/**
|
||||
* Describes the data returned by after wantAgent.trigger is called.
|
||||
*
|
||||
* @typedef CompleteData
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent#CompleteData
|
||||
*/
|
||||
export interface CompleteData {
|
||||
/**
|
||||
* Triggered WantAgent.
|
||||
@ -391,6 +697,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#info
|
||||
*/
|
||||
/**
|
||||
* Triggered WantAgent.
|
||||
*
|
||||
* @type { WantAgent }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#info
|
||||
*/
|
||||
info: WantAgent;
|
||||
|
||||
/**
|
||||
@ -402,6 +718,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#want
|
||||
*/
|
||||
/**
|
||||
* Existing Want that is triggered.
|
||||
*
|
||||
* @type { Want }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#want
|
||||
*/
|
||||
want: Want;
|
||||
|
||||
/**
|
||||
@ -413,6 +739,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#finalCode
|
||||
*/
|
||||
/**
|
||||
* Request code used to trigger the WantAgent.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#finalCode
|
||||
*/
|
||||
finalCode: number;
|
||||
|
||||
/**
|
||||
@ -424,6 +760,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#finalData
|
||||
*/
|
||||
/**
|
||||
* Final data collected by the common event.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#finalData
|
||||
*/
|
||||
finalData: string;
|
||||
|
||||
/**
|
||||
@ -435,6 +781,16 @@ declare namespace wantAgent {
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#extraInfo
|
||||
*/
|
||||
/**
|
||||
* Extra data collected by the common event.
|
||||
*
|
||||
* @type { ?object }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 9
|
||||
* @useinstead ohos.app.ability.wantAgent/wantAgent.CompleteData#extraInfo
|
||||
*/
|
||||
extraInfo?: { [key: string]: any };
|
||||
}
|
||||
}
|
||||
|
||||
56
api/wantAgent/triggerInfo.d.ts
vendored
56
api/wantAgent/triggerInfo.d.ts
vendored
@ -28,6 +28,14 @@ import StartOptions from '../@ohos.app.ability.StartOptions';
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Provides the information required for triggering a WantAgent.
|
||||
*
|
||||
* @typedef TriggerInfo
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export interface TriggerInfo {
|
||||
/**
|
||||
* Result code.
|
||||
@ -36,6 +44,14 @@ export interface TriggerInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Result code.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
code: number;
|
||||
|
||||
/**
|
||||
@ -50,6 +66,19 @@ export interface TriggerInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Extra Want.
|
||||
* If flags in WantAgentInfo contain CONSTANT_FLAG, this parameter is invalid.
|
||||
* If flags contain REPLACE_ELEMENT, REPLACE_ACTION, REPLACE_URI, REPLACE_ENTITIES, and REPLACE_BUNDLE,
|
||||
* the element, action, uri, entities, and bundleName attributes of the Want specified in this parameter
|
||||
* will be used to replace the corresponding attributes in the original Want, respectively.
|
||||
* If this parameter is null, the original Want remains unchanged.
|
||||
*
|
||||
* @type { ?Want }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
want?: Want;
|
||||
|
||||
/**
|
||||
@ -61,6 +90,16 @@ export interface TriggerInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Permission required for a WantAgent recipient.
|
||||
* This parameter is valid only when the WantAgent is triggered to send common events.
|
||||
* If permission is null, no permission is required on the recipient.
|
||||
*
|
||||
* @type { ?string }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
permission?: string;
|
||||
|
||||
/**
|
||||
@ -70,6 +109,14 @@ export interface TriggerInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Custom extra data you want to add for triggering a WantAgent.
|
||||
*
|
||||
* @type { ?object }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
extraInfo?: { [key: string]: any };
|
||||
|
||||
/**
|
||||
@ -80,6 +127,15 @@ export interface TriggerInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Custom extra data you want to add for triggering a WantAgent.
|
||||
* The ability of this property is same as extraInfo. If both are set, this property will be used.
|
||||
*
|
||||
* @type { ?Record<string, Object> }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
extraInfos?: Record<string, Object>;
|
||||
|
||||
/**
|
||||
|
||||
79
api/wantAgent/wantAgentInfo.d.ts
vendored
79
api/wantAgent/wantAgentInfo.d.ts
vendored
@ -29,6 +29,14 @@ import type abilityWantAgent from '../@ohos.app.ability.wantAgent';
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Provides the information required for triggering a WantAgent.
|
||||
*
|
||||
* @typedef WantAgentInfo
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
export interface WantAgentInfo {
|
||||
/**
|
||||
* An array of all Wants for starting abilities or sending common events. Only Wants can be displayed.
|
||||
@ -37,6 +45,14 @@ export interface WantAgentInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* An array of all Wants for starting abilities or sending common events. Only Wants can be displayed.
|
||||
*
|
||||
* @type { Array<Want> }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
wants: Array<Want>;
|
||||
|
||||
/**
|
||||
@ -48,6 +64,16 @@ export interface WantAgentInfo {
|
||||
* @deprecated since 11
|
||||
* @useinstead WantAgentInfo#actionType
|
||||
*/
|
||||
/**
|
||||
* Type of the action specified in a Want.
|
||||
*
|
||||
* @type { ?wantAgent.OperationType }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 11
|
||||
* @useinstead WantAgentInfo#actionType
|
||||
*/
|
||||
operationType?: wantAgent.OperationType;
|
||||
|
||||
/**
|
||||
@ -57,6 +83,14 @@ export interface WantAgentInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Type of the action specified in a Want.
|
||||
*
|
||||
* @type { ?abilityWantAgent.OperationType }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
actionType?: abilityWantAgent.OperationType;
|
||||
|
||||
/**
|
||||
@ -66,6 +100,14 @@ export interface WantAgentInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Request code defined by the user.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
requestCode: number;
|
||||
|
||||
/**
|
||||
@ -77,6 +119,16 @@ export interface WantAgentInfo {
|
||||
* @deprecated since 11
|
||||
* @useinstead WantAgentInfo#actionFlags
|
||||
*/
|
||||
/**
|
||||
* An array of flags for using the WantAgent.
|
||||
*
|
||||
* @type { ?Array<wantAgent.WantAgentFlags> }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
* @deprecated since 11
|
||||
* @useinstead WantAgentInfo#actionFlags
|
||||
*/
|
||||
wantAgentFlags?: Array<wantAgent.WantAgentFlags>;
|
||||
|
||||
/**
|
||||
@ -86,6 +138,14 @@ export interface WantAgentInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* An array of flags for using the WantAgent.
|
||||
*
|
||||
* @type { ?Array<abilityWantAgent.WantAgentFlags> }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
actionFlags?: Array<abilityWantAgent.WantAgentFlags>;
|
||||
|
||||
/**
|
||||
@ -96,6 +156,15 @@ export interface WantAgentInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 7
|
||||
*/
|
||||
/**
|
||||
* Extra information about how the Want starts an ability.
|
||||
* If there is no extra information to set, this constant can be left empty.
|
||||
*
|
||||
* @type { ?object }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
extraInfo?: { [key: string]: any };
|
||||
|
||||
/**
|
||||
@ -107,5 +176,15 @@ export interface WantAgentInfo {
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @since 11
|
||||
*/
|
||||
/**
|
||||
* Extra information about how the Want starts an ability.
|
||||
* If there is no extra information to set, this constant can be left empty.
|
||||
* The ability of this property is same as extraInfo. If both are set, this property will be used.
|
||||
*
|
||||
* @type { ?Record<string, Object> }
|
||||
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
||||
* @atomicservice
|
||||
* @since 12
|
||||
*/
|
||||
extraInfos?: Record<string, Object>;
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user