From 4ece6ce312b2a84fc6f8ab031a2e075021feedfd Mon Sep 17 00:00:00 2001 From: zhangzezhong Date: Wed, 3 Sep 2025 19:53:24 +0800 Subject: [PATCH] add formExtension sdk Signed-off-by: zhangzezhong --- ...hos.app.form.FormEditExtensionAbility.d.ts | 6 ++- api/@ohos.app.form.FormExtensionAbility.d.ts | 53 +++++++++++++++++++ api/application/FormExtensionContext.d.ts | 29 +++++----- kits/@kit.FormKit.d.ts | 3 +- 4 files changed, 75 insertions(+), 16 deletions(-) diff --git a/api/@ohos.app.form.FormEditExtensionAbility.d.ts b/api/@ohos.app.form.FormEditExtensionAbility.d.ts index 975799bfc6..4b86942df8 100644 --- a/api/@ohos.app.form.FormEditExtensionAbility.d.ts +++ b/api/@ohos.app.form.FormEditExtensionAbility.d.ts @@ -26,7 +26,8 @@ import FormEditExtensionContext from './application/FormEditExtensionContext'; * @extends UIExtensionAbility * @syscap SystemCapability.Ability.Form * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class FormEditExtensionAbility extends UIExtensionAbility { /** @@ -35,7 +36,8 @@ declare class FormEditExtensionAbility extends UIExtensionAbility { * @type { FormEditExtensionContext } * @syscap SystemCapability.Ability.Form * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ context: FormEditExtensionContext; } diff --git a/api/@ohos.app.form.FormExtensionAbility.d.ts b/api/@ohos.app.form.FormExtensionAbility.d.ts index 268b20c643..0d5f8f4216 100644 --- a/api/@ohos.app.form.FormExtensionAbility.d.ts +++ b/api/@ohos.app.form.FormExtensionAbility.d.ts @@ -42,6 +42,34 @@ import { Configuration } from './@ohos.app.ability.Configuration'; */ type OnAcquireFormStateFn = (want: Want) => formInfo.FormState; +/** + * Called when the system shares the form. + * + * @typedef { function } + * @param { string } formId - Indicates the ID of the form. + * @returns { Record } Returns the wantParams object. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ +type OnShareFormFn = (formId: string) => Record; + +/** + * Called when the system acquire the form data. + * + * @typedef { function } + * @param { string } formId - Indicates the ID of the form. + * @returns { Record } Returns the wantParams object. + * @syscap SystemCapability.Ability.Form + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ +type OnAcquireFormDataFn = (formId: string) => Record; + /** * Called when this ability breaks the last link, notifying the provider that the provider process is about to stop. * @@ -338,6 +366,18 @@ declare class FormExtensionAbility { */ onShareForm?(formId: string): Record; + /** + * Called when the system shares the form. + * + * @type { ?OnShareFormFn } + * @syscap SystemCapability.Ability.Form + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + onShareForm?: OnShareFormFn; + /** * Called when the system acquire the form data. * @@ -360,6 +400,18 @@ declare class FormExtensionAbility { */ onAcquireFormData?(formId: string): Record; + /** + * Called when the system acquire the form data. + * + * @type { ?OnAcquireFormDataFn } + * @syscap SystemCapability.Ability.Form + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + onAcquireFormData?: OnAcquireFormDataFn; + /** * Called when this ability breaks the last link, notifying the provider that the provider process is about to stop. * @@ -391,6 +443,7 @@ declare class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @since 20 + * @arkts 1.1&1.2 */ onFormLocationChanged(formId: string, newFormLocation: formInfo.FormLocation): void; } diff --git a/api/application/FormExtensionContext.d.ts b/api/application/FormExtensionContext.d.ts index 17b56c331f..42eb96e79b 100644 --- a/api/application/FormExtensionContext.d.ts +++ b/api/application/FormExtensionContext.d.ts @@ -18,11 +18,9 @@ * @kit FormKit */ -/*** if arkts 1.1 */ import { AsyncCallback } from '../@ohos.base'; import type { ConnectOptions } from '../ability/connectOptions'; import Want from '../@ohos.app.ability.Want'; -/*** endif */ import ExtensionContext from './ExtensionContext'; /** @@ -77,7 +75,8 @@ declare class FormExtensionContext extends ExtensionContext { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ startAbility(want: Want, callback: AsyncCallback): void; @@ -112,7 +111,8 @@ declare class FormExtensionContext extends ExtensionContext { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ startAbility(want: Want): Promise; @@ -128,7 +128,7 @@ declare class FormExtensionContext extends ExtensionContext { * * @param { Want } want - Indicates the service extension to connect. * @param { ConnectOptions } options - Indicates the callback of connection. - * @returns { number } Returns the connection id. + * @returns { long } Returns the connection id. * @throws { BusinessError } 201 - The application does not have permission to call the interface. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. @@ -145,14 +145,15 @@ declare class FormExtensionContext extends ExtensionContext { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; + connectServiceExtensionAbility(want: Want, options: ConnectOptions): long; /** * Disconnect an ability to a service extension, in contrast to {@link connectServiceExtensionAbility}. * - * @param { number } connection - the connection id returned from connectServiceExtensionAbility api. + * @param { long } connection - the connection id returned from connectServiceExtensionAbility api. * @param { AsyncCallback } callback - The callback of disconnectServiceExtensionAbility. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. @@ -161,14 +162,15 @@ declare class FormExtensionContext extends ExtensionContext { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - disconnectServiceExtensionAbility(connection: number, callback: AsyncCallback): void; + disconnectServiceExtensionAbility(connection: long, callback: AsyncCallback): void; /** * Disconnect an ability to a service extension, in contrast to {@link connectServiceExtensionAbility}. * - * @param { number } connection - the connection id returned from connectServiceExtensionAbility api. + * @param { long } connection - the connection id returned from connectServiceExtensionAbility api. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. @@ -177,9 +179,10 @@ declare class FormExtensionContext extends ExtensionContext { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - disconnectServiceExtensionAbility(connection: number): Promise; + disconnectServiceExtensionAbility(connection: long): Promise; } export default FormExtensionContext; \ No newline at end of file diff --git a/kits/@kit.FormKit.d.ts b/kits/@kit.FormKit.d.ts index 95cfa3a0fe..c6ebb79212 100644 --- a/kits/@kit.FormKit.d.ts +++ b/kits/@kit.FormKit.d.ts @@ -42,8 +42,9 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility'; import formInfo from '@ohos.app.form.formInfo'; import formProvider from '@ohos.app.form.formProvider'; import formError from '@ohos.application.formError'; +import FormEditExtensionAbility from '@ohos.app.form.FormEditExtensionAbility'; export { - FormExtensionAbility, formBindingData, formError, formInfo, formProvider + FormExtensionAbility, formBindingData, formError, formInfo, formProvider, FormEditExtensionAbility }; /*** endif */ \ No newline at end of file -- Gitee