1/* 2 * Copyright (c) 2022-2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit FormKit 19 * @arkts 1.1&1.2 20 */ 21 22/** 23 * Interface of formBindingData. 24 * 25 * @namespace formBindingData 26 * @syscap SystemCapability.Ability.Form 27 * @since 9 28 */ 29/** 30 * Interface of formBindingData. 31 * 32 * @namespace formBindingData 33 * @syscap SystemCapability.Ability.Form 34 * @atomicservice 35 * @since arkts {'1.1':'11', '1.2':'20'} 36 * @arkts 1.1&1.2 37 */ 38declare namespace formBindingData { 39 /** 40 * Create an FormBindingData instance. 41 * 42 * @param { Object | string } [obj] - Indicates the FormBindingData instance data. 43 * @returns { FormBindingData } Returns the FormBindingData. 44 * @throws { BusinessError } 401 - Parameter error. Possible causes: 45 * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. 46 * @syscap SystemCapability.Ability.Form 47 * @since 9 48 */ 49 /** 50 * Create an FormBindingData instance. 51 * 52 * @param { Object | string } [obj] - Indicates the FormBindingData instance data. 53 * @returns { FormBindingData } Returns the FormBindingData. 54 * @throws { BusinessError } 401 - Parameter error. Possible causes: 55 * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. 56 * @syscap SystemCapability.Ability.Form 57 * @atomicservice 58 * @since arkts {'1.1':'11', '1.2':'20'} 59 * @arkts 1.1&1.2 60 */ 61 function createFormBindingData(obj?: Object | string): FormBindingData; 62 63 /** 64 * Defines the createFormBindingData result interface. 65 * 66 * @typedef FormBindingData 67 * @syscap SystemCapability.Ability.Form 68 * @since 9 69 */ 70 /** 71 * Defines the createFormBindingData result interface. 72 * 73 * @typedef FormBindingData 74 * @syscap SystemCapability.Ability.Form 75 * @atomicservice 76 * @since arkts {'1.1':'11', '1.2':'20'} 77 * @arkts 1.1&1.2 78 */ 79 interface FormBindingData { 80 /** 81 * Data for updating. 82 * 83 * @type { Object } 84 * @syscap SystemCapability.Ability.Form 85 * @since 9 86 */ 87 /** 88 * Data for updating. 89 * 90 * @type { Object } 91 * @syscap SystemCapability.Ability.Form 92 * @atomicservice 93 * @since arkts {'1.1':'11', '1.2':'20'} 94 * @arkts 1.1&1.2 95 */ 96 data: Object; 97 98 /** 99 * proxies for updating. 100 * 101 * @type { ?Array<ProxyData> } 102 * @syscap SystemCapability.Ability.Form 103 * @StageModelOnly 104 * @since 10 105 */ 106 /** 107 * proxies for updating. 108 * 109 * @type { ?Array<ProxyData> } 110 * @syscap SystemCapability.Ability.Form 111 * @StageModelOnly 112 * @atomicservice 113 * @since arkts {'1.1':'11', '1.2':'20'} 114 * @arkts 1.1&1.2 115 */ 116 proxies?: Array<ProxyData>; 117 } 118 119 /** 120 * Defines the form proxy data. 121 * 122 * @typedef ProxyData 123 * @syscap SystemCapability.Ability.Form 124 * @StageModelOnly 125 * @since 10 126 */ 127 /** 128 * Defines the form proxy data. 129 * 130 * @typedef ProxyData 131 * @syscap SystemCapability.Ability.Form 132 * @StageModelOnly 133 * @atomicservice 134 * @since arkts {'1.1':'11', '1.2':'20'} 135 * @arkts 1.1&1.2 136 */ 137 interface ProxyData { 138 /** 139 * Key for proxy. The value depend data publisher. 140 * 141 * @type { string } 142 * @syscap SystemCapability.Ability.Form 143 * @StageModelOnly 144 * @since 10 145 */ 146 /** 147 * Key for proxy. The value depend data publisher. 148 * 149 * @type { string } 150 * @syscap SystemCapability.Ability.Form 151 * @StageModelOnly 152 * @atomicservice 153 * @since arkts {'1.1':'11', '1.2':'20'} 154 * @arkts 1.1&1.2 155 */ 156 key: string; 157 158 /** 159 * SubscriberId. The value depend data publisher. The default value is current formId. 160 * 161 * @type { ?string } 162 * @syscap SystemCapability.Ability.Form 163 * @StageModelOnly 164 * @since 10 165 */ 166 /** 167 * SubscriberId. The value depend data publisher. The default value is current formId. 168 * 169 * @type { ?string } 170 * @syscap SystemCapability.Ability.Form 171 * @StageModelOnly 172 * @atomicservice 173 * @since arkts {'1.1':'11', '1.2':'20'} 174 * @arkts 1.1&1.2 175 */ 176 subscriberId?: string; 177 } 178} 179export default formBindingData; 180