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-basic-components-button.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
101## SaveButtonOnClickResult枚举说明
102
103**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
104
105**系统能力:** SystemCapability.ArkUI.ArkUI.Full
106
107| 名称 | 值 | 说明 |
108| -------- | -------- | -------- |
109| SUCCESS | 0 | 保存按钮点击成功。 |
110| TEMPORARY_AUTHORIZATION_FAILED | 1 | 保存按钮点击后权限授权失败。 |
111
112## 属性
113
114不支持通用属性,仅继承[安全控件通用属性](ts-securitycomponent-attributes.md#属性)。
115
116## 事件
117
118不支持通用事件,仅支持以下事件:
119
120### onClick
121
122onClick(event: (event: ClickEvent, result: SaveButtonOnClickResult) =&gt; void)
123
124点击动作触发该回调
125
126**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
127
128**系统能力:** SystemCapability.ArkUI.ArkUI.Full
129
130**参数:**
131
132| 参数名 | 类型                   | 必填 | 说明                   |
133|------------|------|-------|---------|
134| event  | [ClickEvent](ts-universal-events-click.md#clickevent对象说明) |是 |见ClickEvent对象说明|
135| result | [SaveButtonOnClickResult](#savebuttononclickresult枚举说明)| 是 | 存储权限的授权结果,授权时长为10秒,即触发点击后,可以在10秒之内不限制次数的调用特定媒体库接口,超出10秒的调用会鉴权失败。|
136
137## 示例
138
139```ts
140// xxx.ets
141import { photoAccessHelper } from '@kit.MediaLibraryKit';
142import { fileIo } from '@kit.CoreFileKit';
143
144@Entry
145@Component
146struct Index {
147  build() {
148    Row() {
149      Column({space:10}) {
150        // 默认参数下,图标、文字、背景都存在
151        SaveButton().onClick(async (event:ClickEvent, result:SaveButtonOnClickResult) => {
152          if (result == SaveButtonOnClickResult.SUCCESS) {
153            try {
154              const context = getContext(this);
155              let helper = photoAccessHelper.getPhotoAccessHelper(context);
156              // onClick触发后10秒内通过createAsset接口创建图片文件,10秒后createAsset权限收回。
157              let uri = await helper.createAsset(photoAccessHelper.PhotoType.IMAGE, 'png');
158              // 使用uri打开文件,可以持续写入内容,写入过程不受时间限制
159              let file = await fileIo.open(uri, fileIo.OpenMode.READ_WRITE | fileIo.OpenMode.CREATE);
160              // 写入文件
161              await fileIo.write(file.fd, "context");
162              // 关闭文件
163              await fileIo.close(file.fd);
164            } catch (error) {
165              console.error("error is "+ JSON.stringify(error));
166            }
167          }
168        })
169        // 传入参数即表示元素存在,不传入的参数表示元素不存在,如果不传入buttonType,会默认添加ButtonType.Capsule配置,显示图标+背景。
170        SaveButton({icon:SaveIconStyle.FULL_FILLED})
171        // 只显示图标+背景,如果设置背景色高八位的α值低于0x1A,则会被系统强制调整为0xFF
172        SaveButton({icon:SaveIconStyle.FULL_FILLED, buttonType:ButtonType.Capsule})
173          .backgroundColor(0x10007dff)
174        // 图标、文字、背景都存在,如果设置背景色高八位的α值低于0x1A,则会被系统强制调整为0xFF
175        SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule})
176        // 图标、文字、背景都存在,如果设置宽度小于当前属性组合下允许的最小宽度时,宽度仍为设置值,此时按钮文本信息会自动换行,以保证安全控件显示的完整性。
177        SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule})
178          .fontSize(16)
179          .width(30)
180        // 图标、文字、背景都存在,如果设置宽度小于当前属性组合下允许的最小宽度时,宽度仍为设置值,此时按钮文本信息会自动换行,以保证安全控件显示的完整性。
181        SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule})
182          .fontSize(16)
183          .size({width: 30, height: 30})
184        // 图标、文字、背景都存在,如果设置宽度小于当前属性组合下允许的最小宽度时,宽度仍为设置值,此时按钮文本信息会自动换行,以保证安全控件显示的完整性。
185        SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule})
186          .fontSize(16)
187          .constraintSize({minWidth: 0, maxWidth: 30, minHeight: 0, maxHeight: 30})
188      }.width('100%')
189    }.height('100%')
190  }
191}
192```
193
194![zh-cn_image_0000001643320073](figures/zh-cn_image_0000001643320073.png)
195