1# SaveButton 2 3安全控件的保存控件，用户通过点击该保存按钮，可以临时获取存储权限，而不需要权限弹框授权确认。 4 5> **说明：** 6> 7> 该组件从API Version 10开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## 子组件 10 11不支持。 12 13## 接口 14 15### SaveButton 16 17SaveButton() 18 19默认创建带有图标、文本、背景的保存按钮。 20 21为避免控件样式不合法导致授权失败，请开发者先了解安全控件样式的[约束与限制](../../../security/AccessToken/security-component-overview.md#约束与限制)。 22 23**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 24 25**系统能力：** SystemCapability.ArkUI.ArkUI.Full 26 27### SaveButton 28 29SaveButton(options: SaveButtonOptions) 30 31创建包含指定元素的保存按钮。 32 33为避免控件样式不合法导致授权失败，请开发者先了解安全控件样式的[约束与限制](../../../security/AccessToken/security-component-overview.md#约束与限制)。 34 35**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 36 37**系统能力：** SystemCapability.ArkUI.ArkUI.Full 38 39**参数：** 40 41| 参数名 | 类型 | 必填 | 说明 | 42| -------- | -------- | -------- | -------- | 43| options | [SaveButtonOptions](#savebuttonoptions) | 是 | 创建包含指定元素的保存按钮。 | 44 45## SaveButtonOptions 46 47用于指定保存按钮的图标、文本等指定元素。 48 49> **说明：** 50> 51> - icon或text需至少传入一个。<br> 52> - 如果icon、text都不传入，[SaveButton](#savebutton-1)中的options参数不起效，创建的SaveButton为默认样式，默认样式： 53> 54> SaveIconStyle默认样式为FULL_FILLED； 55> 56> SaveDescription默认样式为DOWNLOAD； 57> 58> ButtonType默认样式为Capsule。 59> - icon、text、buttonType不支持动态修改。 60 61**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 62 63**系统能力：** SystemCapability.ArkUI.ArkUI.Full 64 65| 名称 | 类型 | 必填 | 说明 | 66| -------- | -------- | -------- | -------- | 67| icon | [SaveIconStyle](#saveiconstyle枚举说明) | 否 | 设置保存按钮的图标风格。<br/>不传入该参数表示没有图标。 | 68| text | [SaveDescription](#savedescription枚举说明) | 否 | 设置保存按钮的文本描述。<br/>不传入该参数表示没有文字描述。 | 69| buttonType | [ButtonType](ts-securitycomponent-attributes.md#buttontype枚举说明) | 否 | 设置保存按钮的背景样式。<br/>不传入该参数，系统默认提供Capsule类型按钮。 | 70 71## SaveIconStyle枚举说明 72 73**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 74 75**系统能力：** SystemCapability.ArkUI.ArkUI.Full 76 77| 名称 | 值 | 说明 | 78| -------- | -------- | -------- | 79| FULL_FILLED | 0 | 保存按钮展示填充样式图标。 | 80| LINES | 1 | 保存按钮展示线条样式图标。 | 81 82## SaveDescription枚举说明 83 84**系统能力：** SystemCapability.ArkUI.ArkUI.Full 85 86| 名称 | 值 | 说明 | 87| -------- | -------- | -------- | 88| DOWNLOAD | 0 | 保存按钮的文字描述为“下载”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 89| DOWNLOAD_FILE | 1 | 保存按钮的文字描述为“下载文件”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 90| SAVE | 2 | 保存按钮的文字描述为“保存”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 91| SAVE_IMAGE | 3 | 保存按钮的文字描述为“保存图片”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 92| SAVE_FILE | 4 | 保存按钮的文字描述为“保存文件”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 93| DOWNLOAD_AND_SHARE | 5 | 保存按钮的文字描述为“下载分享”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 94| RECEIVE | 6 | 保存按钮的文字描述为“接收”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 95| CONTINUE_TO_RECEIVE | 7 | 保存按钮的文字描述为“继续接收”。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 96| SAVE_TO_GALLERY<sup>12+</sup> | 8 | 保存按钮的文字描述为“保存至图库”。 <br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 97| EXPORT_TO_GALLERY<sup>12+</sup> | 9 | 保存按钮的文字描述为“导出”。 <br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 98| QUICK_SAVE_TO_GALLERY<sup>12+</sup> | 10 | 保存按钮的文字描述为“快速保存图片”。 <br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 99| RESAVE_TO_GALLERY<sup>12+</sup> | 11 | 保存按钮的文字描述为“重新保存”。 <br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 100| SAVE_ALL<sup>18+</sup> | 12 | 保存按钮的文字描述为“全部保存”。 <br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | 101 102## SaveButtonOnClickResult枚举说明 103 104**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 105 106**系统能力：** SystemCapability.ArkUI.ArkUI.Full 107 108| 名称 | 值 | 说明 | 109| -------- | -------- | -------- | 110| SUCCESS | 0 | 保存按钮点击成功。 | 111| TEMPORARY_AUTHORIZATION_FAILED | 1 | 保存按钮点击后权限授权失败。 | 112 113## SaveButtonCallback<sup>18+</sup> 114 115type SaveButtonCallback = (event: ClickEvent, result: SaveButtonOnClickResult, error?: BusinessError<void>) => void 116 117点击保存按钮触发该回调。 118 119**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 120 121**系统能力：** SystemCapability.ArkUI.ArkUI.Full 122 123| 参数名 | 类型 | 必填 | 说明 | 124|------------|------|-------|---------| 125| event | [ClickEvent](ts-universal-events-click.md#clickevent对象说明) |是 |见ClickEvent对象说明。| 126| result | [SaveButtonOnClickResult](#savebuttononclickresult枚举说明)| 是 | 存储权限的授权结果，授权时长为10秒，即触发点击后，可以在10秒之内不限制次数的调用特定媒体库接口，超出10秒的调用会鉴权失败。| 127| error | [BusinessError<void>](../../apis-basic-services-kit/js-apis-base.md#businesserror) | 否 | 点击按钮时的错误码和错误信息。<br>错误码0表示点击保存按钮授权成功。<br>错误码1表示系统内部错误。<br>错误码2表示属性设置错误，包括但不限于：<br>1. 字体或图标设置过小。<br>2. 字体或图标与背托颜色相近。<br>3. 字体或图标颜色过于透明。<br>4. padding为负值。<br>5. 按钮被其他组件或窗口遮挡。<br>6. 文本超出背托范围。<br>7. 按钮超出窗口或屏幕。<br>8. 按钮整体尺寸过大。<br>9. 按钮文本被截断，显示不全。<br>10. 相关属性设置影响安全控件显示。| 128 129## 属性 130 131不支持通用属性，仅继承[安全控件通用属性](ts-securitycomponent-attributes.md#属性)。 132 133## 事件 134 135不支持通用事件，仅支持以下事件： 136 137### onClick 138 139onClick(event: SaveButtonCallback) 140 141点击动作触发该回调。 142 143**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 144 145**系统能力：** SystemCapability.ArkUI.ArkUI.Full 146 147**参数：** 148 149| 参数名 | 类型 | 必填 | 说明 | 150|------------|------|-------|---------| 151| event | [SaveButtonCallback](#savebuttoncallback18) |是 |见SaveButtonCallback。<br>在API10-17时，参数类型为：(event: [ClickEvent](ts-universal-events-click.md#clickevent对象说明), result: [SaveButtonOnClickResult](#savebuttononclickresult枚举说明)) => void。<br>从API18开始，变更为SaveButtonCallback。| 152 153## 示例 154 155```ts 156// xxx.ets 157import { photoAccessHelper } from '@kit.MediaLibraryKit'; 158import { fileIo } from '@kit.CoreFileKit'; 159import { BusinessError } from '@kit.BasicServicesKit'; 160 161@Entry 162@Component 163struct Index { 164 handleSaveButtonClick: SaveButtonCallback = 165 async (event: ClickEvent, result: SaveButtonOnClickResult, error: BusinessError<void>) => { 166 if (result == SaveButtonOnClickResult.SUCCESS) { 167 try { 168 const context = this.getUIContext().getHostContext(); 169 let helper = photoAccessHelper.getPhotoAccessHelper(context); 170 // onClick触发后10秒内通过createAsset接口创建图片文件，10秒后createAsset权限收回。 171 let uri = await helper.createAsset(photoAccessHelper.PhotoType.IMAGE, 'png'); 172 // 使用uri打开文件，可以持续写入内容，写入过程不受时间限制。 173 let file = await fileIo.open(uri, fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE); 174 // 写入文件。 175 await fileIo.write(file.fd, "context"); 176 // 关闭文件。 177 await fileIo.close(file.fd); 178 } catch (error) { 179 console.error("error is " + JSON.stringify(error)); 180 } 181 } else { 182 console.info("errCode: " + error.code); 183 console.info("errMessage: " + error.message); 184 } 185 }; 186 187 build() { 188 Row() { 189 Column({ space: 10 }) { 190 // 默认参数下，图标、文字、背景都存在。 191 SaveButton().onClick((this.handleSaveButtonClick)) 192 // 传入参数即表示元素存在，不传入的参数表示元素不存在，如果不传入buttonType，会默认添加ButtonType.Capsule配置，显示图标+背景。 193 SaveButton({ icon: SaveIconStyle.FULL_FILLED }) 194 // 只显示图标+背景，如果设置背景色高八位的α值低于0x1A，则会被系统强制调整为0xFF。 195 SaveButton({ icon: SaveIconStyle.FULL_FILLED, buttonType: ButtonType.Capsule }) 196 .backgroundColor(0x10007dff) 197 // 图标、文字、背景都存在，如果设置背景色高八位的α值低于0x1A，则会被系统强制调整为0xFF。 198 SaveButton({ icon: SaveIconStyle.FULL_FILLED, text: SaveDescription.DOWNLOAD, buttonType: ButtonType.Capsule }) 199 // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。 200 SaveButton({ icon: SaveIconStyle.FULL_FILLED, text: SaveDescription.DOWNLOAD, buttonType: ButtonType.Capsule }) 201 .fontSize(16) 202 .width(30) 203 // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。 204 SaveButton({ icon: SaveIconStyle.FULL_FILLED, text: SaveDescription.DOWNLOAD, buttonType: ButtonType.Capsule }) 205 .fontSize(16) 206 .size({ width: 30, height: 30 }) 207 // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。 208 SaveButton({ icon: SaveIconStyle.FULL_FILLED, text: SaveDescription.DOWNLOAD, buttonType: ButtonType.Capsule }) 209 .fontSize(16) 210 .constraintSize({ 211 minWidth: 0, 212 maxWidth: 30, 213 minHeight: 0, 214 maxHeight: 30 215 }) 216 }.width('100%') 217 }.height('100%') 218 } 219} 220``` 221 222 223
