1 Star 0 Fork 3.9K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.app.ability.wantAgent.d.ts 30.40 KB
一键复制 编辑 原始数据 按行查看 历史
苏小桀 提交于 2024-08-26 16:41 +08:00 . backgroundkit wantAgent元服务标签补充
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
/*
* Copyright (c) 2022-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import { AsyncCallback, Callback } from './@ohos.base';
import Want from './@ohos.app.ability.Want';
import { WantAgentInfo as _WantAgentInfo } from './wantAgent/wantAgentInfo';
import { TriggerInfo as _TriggerInfo } from './wantAgent/triggerInfo';
/**
* 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
* @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.
*
* @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
* @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;
/**
* 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
* @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>;
/**
* 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
* @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;
/**
* 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
* @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>;
/**
* Obtains the {@link Want} of an {@link WantAgent}.
*
* @param { WantAgent } agent - Indicates the WantAgent.
* @param { AsyncCallback<Want> } callback - The callback is used to return the Want.
* @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
* @systemapi
* @since 9
*/
function getWant(agent: WantAgent, callback: AsyncCallback<Want>): void;
/**
* Obtains the {@link Want} of an {@link WantAgent}.
*
* @param { WantAgent } agent - Indicates the WantAgent.
* @returns { Promise<Want> } Returns the Want.
* @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
* @systemapi
* @since 9
*/
function getWant(agent: WantAgent): Promise<Want>;
/**
* 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
* @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;
/**
* 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
* @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>;
/**
* 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
* @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;
/**
* 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
* @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;
/**
* 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
* @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>;
/**
* 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
* @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;
/**
* 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
* @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>;
/**
* 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
* @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;
/**
* 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
* @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>;
/**
* Enumerates flags for using a WantAgent.
*
* @enum { number }
* @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.
* This flag is valid only when OperationType is set to START_ABILITY, START_SERVICE, or SEND_COMMON_EVENT.
*
* @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,
/**
* 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
* @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,
/**
* 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
* @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,
/**
* 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
* @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,
/**
* Indicates that the created WantAgent should be immutable.
*
* @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,
/**
* Indicates that the current value of element can be replaced when the WantAgent is triggered.
*
* @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,
/**
* Indicates that the current value of action can be replaced when the WantAgent is triggered.
*
* @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,
/**
* Indicates that the current value of uri can be replaced when the WantAgent is triggered.
*
* @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,
/**
* Indicates that the current value of entities can be replaced when the WantAgent is triggered.
*
* @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,
/**
* Indicates that the current value of packageName can be replaced when the WantAgent is triggered.
*
* @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
}
/**
* Identifies the operation for using a WantAgent, such as starting an ability or sending a common event.
*
* @enum { number }
* @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.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Unknown operation.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
UNKNOWN_TYPE = 0,
/**
* Starts an ability with a UI.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Starts an ability with a UI.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
START_ABILITY,
/**
* Starts multiple abilities with a UI.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Starts multiple abilities with a UI.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
START_ABILITIES,
/**
* Starts an ability without a UI.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Starts an ability without a UI.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
START_SERVICE,
/**
* Sends a common event.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Sends a common event.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
SEND_COMMON_EVENT,
/**
* Starts a service extension.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 12
*/
START_SERVICE_EXTENSION = 6
}
/**
* Describes the data returned by after wantAgent.trigger is called.
*
* @typedef CompleteData
* @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.
*
* @type { WantAgent }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Triggered WantAgent.
*
* @type { WantAgent }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
info: WantAgent;
/**
* Existing Want that is triggered.
*
* @type { Want }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Existing Want that is triggered.
*
* @type { Want }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @atomicservice
* @since 12
*/
want: Want;
/**
* Request code used to trigger the WantAgent.
*
* @type { number }
* @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;
/**
* Final data collected by the common event.
*
* @type { string }
* @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;
/**
* Extra data collected by the common event.
*
* @type { ?object }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
/**
* Extra data collected by the common event.
*
* @type { ?Record<string, Object> }
* @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>;
}
/**
* Provides the information required for triggering a WantAgent.
*
* @typedef { _TriggerInfo }
* @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;
/**
* Provides the information required for triggering a WantAgent.
*
* @typedef { _WantAgentInfo }
* @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;
}
/**
* WantAgent object.
*
* @typedef { object }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @since 9
*/
export type WantAgent = object;
export default wantAgent;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助