• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# SaveButton
2
3
4安全控件的保存控件,用户通过点击该保存按钮,可以临时获取存储权限,而不需要权限弹框授权确认。
5
6
7> **说明:**
8>
9> 该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
10
11
12## 子组件
13
14不支持。
15
16
17## 接口
18
19### SaveButton
20SaveButton()
21
22默认创建带有图标、文本、背景的保存按钮。
23
24### SaveButton
25SaveButton(option:{icon?: SaveIconStyle, text?: SaveDescription, buttonType?: ButtonType})
26
27创建包含指定元素的保存按钮。
28
29**参数:**
30
31| 参数名 | 参数类型 | 必填 | 参数描述 |
32| -------- | -------- | -------- | -------- |
33| icon | [SaveIconStyle](#saveiconstyle枚举说明) | 否 | 设置保存按钮的图标风格<br/>不传入该参数表示没有图标,icon和text至少存在一个。 |
34| text | [SaveDescription](#savedescription枚举说明) | 否 | 设置保存按钮的文本描述<br/>不传入该参数表示没有文字描述,icon和text至少存在一个。 |
35| buttonType | [ButtonType](ts-basic-components-button.md#buttontype枚举说明) | 否 | 设置保存按钮的背景样式<br/>不传入该参数表示没有背景。 |
36
37
38## SaveIconStyle枚举说明
39
40| 名称 | 枚举值 | 描述 |
41| -------- | -------- | -------- |
42| FULL_FILLED | 0 | 保存按钮展示填充样式图标。 |
43| LINES | 1 | 保存按钮展示线条样式图标。 |
44
45
46## SaveDescription枚举说明
47
48| 名称 | 枚举值 | 描述 |
49| -------- | -------- | -------- |
50| DOWNLOAD | 0 | 保存按钮的文字描述为“下载”。 |
51| DOWNLOAD_FILE | 1 | 保存按钮的文字描述为“下载文件”。 |
52| SAVE | 2 | 保存按钮的文字描述为“保存”。 |
53| SAVE_IMAGE | 3 | 保存按钮的文字描述为“保存图片”。 |
54| SAVE_FILE | 4 | 保存按钮的文字描述为“保存文件”。 |
55| DOWNLOAD_AND_SHARE | 5 | 保存按钮的文字描述为“下载分享”。 |
56| RECEIVE | 6 | 保存按钮的文字描述为“接收”。 |
57| CONTINUE_TO_RECEIVE | 7 | 保存按钮的文字描述为“继续接收”。 |
58
59
60## SaveButtonOnClickResult枚举说明
61
62| 名称 | 枚举值 | 描述 |
63| -------- | -------- | -------- |
64| SUCCESS | 0 | 保存按钮点击成功。 |
65| TEMPORARY_AUTHORIZATION_FAILED | 1 | 保存按钮点击后权限授权失败。 |
66
67
68## 属性
69
70不支持通用属性,仅继承[安全控件通用属性](ts-securitycomponent-attributes.md#属性)。
71
72
73## 事件
74
75不支持通用事件,仅支持以下事件:
76
77| 名称 | 功能描述 |
78| -------- | -------- |
79| onClick(event: (event: [ClickEvent](ts-universal-events-click.md#clickevent对象说明), result: [SaveButtonOnClickResult](#savebuttononclickresult枚举说明)) =&gt; void) | 点击动作触发该回调。<br/>result:存储权限的授权结果,授权方式为5秒单次,即触发点击后,可以在5秒中之内调用媒体库接口一次,超出5秒或者调用次数超出一次都会鉴权失败。<br/>event:见ClickEvent对象说明。 |
80
81
82## 示例
83
84```
85// xxx.ets
86import photoAccessHelper from '@ohos.file.photoAccessHelper';
87import fs from '@ohos.file.fs';
88
89@Entry
90@Component
91struct Index {
92  build() {
93    Row() {
94      Column({space:10}) {
95        // 默认参数下,图标、文字、背景都存在
96        SaveButton().onClick(async (event:ClickEvent, result:SaveButtonOnClickResult) => {
97          if (result == SaveButtonOnClickResult.SUCCESS) {
98            try {
99              const context = getContext(this);
100              let helper = photoAccessHelper.getPhotoAccessHelper(context);
101              // onClick触发后5秒内通过createAsset接口创建图片文件,5秒后createAsset权限收回。
102              let uri = await helper.createAsset(photoAccessHelper.PhotoType.IMAGE, 'png');
103              // 使用uri打开文件,可以持续写入内容,写入过程不受时间限制
104              let file = await fs.open(uri, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
105              // 写入文件
106              await fs.write(file.fd, "context");
107              // 关闭文件
108              await fs.close(file.fd);
109            } catch (error) {
110              console.error("error is "+ JSON.stringify(error));
111            }
112          }
113        })
114        // 传入参数即表示元素存在,不传入的参数表示元素不存在,例如:只显示图标
115        SaveButton({icon:SaveIconStyle.FULL_FILLED})
116        // 只显示图标+背景
117        SaveButton({icon:SaveIconStyle.FULL_FILLED, buttonType:ButtonType.Capsule})
118        // 图标、文字、背景都存在
119        SaveButton({icon:SaveIconStyle.FULL_FILLED, text:SaveDescription.DOWNLOAD, buttonType:ButtonType.Capsule})
120      }.width('100%')
121    }.height('100%')
122  }
123}
124```
125
126![zh-cn_image_0000001643320073](figures/zh-cn_image_0000001643320073.png)
127