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**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 55 56**系统能力:** SystemCapability.ArkUI.ArkUI.Full 57 58| 名称 | 类型 | 必填 | 说明 | 59| -------- | -------- | -------- | -------- | 60| icon | [SaveIconStyle](#saveiconstyle枚举说明) | 否 | 设置保存按钮的图标风格<br/>不传入该参数表示没有图标。 | 61| text | [SaveDescription](#savedescription枚举说明) | 否 | 设置保存按钮的文本描述<br/>不传入该参数表示没有文字描述。 | 62| buttonType | [ButtonType](ts-basic-components-button.md#buttontype枚举说明) | 否 | 设置保存按钮的背景样式<br/>不传入该参数,系统默认提供Capsule类型按钮。 | 63 64## SaveIconStyle枚举说明 65 66**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 67 68**系统能力:** SystemCapability.ArkUI.ArkUI.Full 69 70| 名称 | 值 | 说明 | 71| -------- | -------- | -------- | 72| FULL_FILLED | 0 | 保存按钮展示填充样式图标。 | 73| LINES | 1 | 保存按钮展示线条样式图标。 | 74 75## SaveDescription枚举说明 76 77**系统能力:** SystemCapability.ArkUI.ArkUI.Full 78 79| 名称 | 值 | 说明 | 80| -------- | -------- | -------- | 81| DOWNLOAD | 0 | 保存按钮的文字描述为“下载”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 82| DOWNLOAD_FILE | 1 | 保存按钮的文字描述为“下载文件”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 83| SAVE | 2 | 保存按钮的文字描述为“保存”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 84| SAVE_IMAGE | 3 | 保存按钮的文字描述为“保存图片”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 85| SAVE_FILE | 4 | 保存按钮的文字描述为“保存文件”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 86| DOWNLOAD_AND_SHARE | 5 | 保存按钮的文字描述为“下载分享”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 87| RECEIVE | 6 | 保存按钮的文字描述为“接收”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 88| CONTINUE_TO_RECEIVE | 7 | 保存按钮的文字描述为“继续接收”。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。| 89| SAVE_TO_GALLERY<sup>12+</sup> | 8 | 保存按钮的文字描述为“保存至图库”。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。| 90| EXPORT_TO_GALLERY<sup>12+</sup> | 9 | 保存按钮的文字描述为“导出”。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。| 91| QUICK_SAVE_TO_GALLERY<sup>12+</sup> | 10 | 保存按钮的文字描述为“快速保存图片”。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。| 92| RESAVE_TO_GALLERY<sup>12+</sup> | 11 | 保存按钮的文字描述为“重新保存”。 <br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。| 93 94## SaveButtonOnClickResult枚举说明 95 96**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 97 98**系统能力:** SystemCapability.ArkUI.ArkUI.Full 99 100| 名称 | 值 | 说明 | 101| -------- | -------- | -------- | 102| SUCCESS | 0 | 保存按钮点击成功。 | 103| TEMPORARY_AUTHORIZATION_FAILED | 1 | 保存按钮点击后权限授权失败。 | 104 105## 属性 106 107不支持通用属性,仅继承[安全控件通用属性](ts-securitycomponent-attributes.md#属性)。 108 109## 事件 110 111不支持通用事件,仅支持以下事件: 112 113### onClick 114 115onClick(event: (event: ClickEvent, result: SaveButtonOnClickResult) => void) 116 117点击动作触发该回调 118 119**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 120 121**系统能力:** SystemCapability.ArkUI.ArkUI.Full 122 123**参数:** 124 125| 参数名 | 类型 | 必填 | 说明 | 126|------------|------|-------|---------| 127| event | [ClickEvent](ts-universal-events-click.md#clickevent对象说明) |是 |见ClickEvent对象说明| 128| result | [SaveButtonOnClickResult](#savebuttononclickresult枚举说明)| 是 | 存储权限的授权结果,授权时长为10秒,即触发点击后,可以在10秒之内不限制次数的调用特定媒体库接口,超出10秒的调用会鉴权失败。| 129 130## 示例 131 132```ts 133// xxx.ets 134import { photoAccessHelper } from '@kit.MediaLibraryKit'; 135import { fileIo } from '@kit.CoreFileKit'; 136 137@Entry 138@Component 139struct Index { 140 build() { 141 Row() { 142 Column({space:10}) { 143 // 默认参数下,图标、文字、背景都存在 144 SaveButton().onClick(async (event:ClickEvent, result:SaveButtonOnClickResult) => { 145 if (result == SaveButtonOnClickResult.SUCCESS) { 146 try { 147 const context = getContext(this); 148 let helper = photoAccessHelper.getPhotoAccessHelper(context); 149 // onClick触发后10秒内通过createAsset接口创建图片文件,10秒后createAsset权限收回。 150 let uri = await helper.createAsset(photoAccessHelper.PhotoType.IMAGE, 'png'); 151 // 使用uri打开文件,可以持续写入内容,写入过程不受时间限制 152 let file = await fileIo.open(uri, fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE); 153 // 写入文件 154 await fileIo.write(file.fd, "context"); 155 // 关闭文件 156 await fileIo.close(file.fd); 157 } catch (error) { 158 console.error("error is "+ JSON.stringify(error)); 159 } 160 } 161 }) 162 // 传入参数即表示元素存在,不传入的参数表示元素不存在,如果不传入buttonType,会默认添加ButtonType.Capsule配置,显示图标+背景。 163 SaveButton({icon:SaveIconStyle.FULL_FILLED}) 164 // 只显示图标+背景,如果设置背景色高八位的α值低于0x1A,则会被系统强制调整为0xFF 165 SaveButton({icon:SaveIconStyle.FULL_FILLED, buttonType:ButtonType.Capsule}) 166 .backgroundColor(0x10007dff) 167 // 图标、文字、背景都存在,如果设置背景色高八位的α值低于0x1A,则会被系统强制调整为0xFF 168 SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule}) 169 // 图标、文字、背景都存在,如果设置宽度小于当前属性组合下允许的最小宽度时,宽度仍为设置值,此时按钮文本信息会自动换行,以保证安全控件显示的完整性。 170 SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule}) 171 .fontSize(16) 172 .width(30) 173 // 图标、文字、背景都存在,如果设置宽度小于当前属性组合下允许的最小宽度时,宽度仍为设置值,此时按钮文本信息会自动换行,以保证安全控件显示的完整性。 174 SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule}) 175 .fontSize(16) 176 .size({width: 30, height: 30}) 177 // 图标、文字、背景都存在,如果设置宽度小于当前属性组合下允许的最小宽度时,宽度仍为设置值,此时按钮文本信息会自动换行,以保证安全控件显示的完整性。 178 SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule}) 179 .fontSize(16) 180 .constraintSize({minWidth: 0, maxWidth: 30, minHeight: 0, maxHeight: 30}) 181 }.width('100%') 182 }.height('100%') 183 } 184} 185``` 186 187 188