共享数据模块

数据结构

`ESSharedData`

共享数据信息

参数	描述	类型	非空
mode	共享模式	`ESSharedDataMode`	是
type	数据类型	`ESSharedDataType`	是
secretKey	数据秘钥	`string`	否
data	数据	`any`	是

`ESSharedDataMode`

共享模式

参数	描述	类型	非空
ES_SHARED_DATA_MODE_PRIVATE	私有模式	`ESSharedDataMode`	是
ES_SHARED_DATA_MODE_WORLD_READABLE	只读	`ESSharedDataMode`	是
ES_SHARED_DATA_MODE_WORLD_WRITEABLE	可写	`ESSharedDataMode`	是

`ESSharedDataType`

共享数据类型

参数	描述	类型	非空
ES_SHARED_DATA_TYPE_INT	int	`ESSharedDataType`	是
ES_SHARED_DATA_TYPE_LONG	long	`ESSharedDataType`	是
ES_SHARED_DATA_TYPE_FLOAT	float	`ESSharedDataType`	是
ES_SHARED_DATA_TYPE_STRING	string	`ESSharedDataType`	是
ES_SHARED_DATA_TYPE_BOOLEAN	boolean	`ESSharedDataType`	是
ES_SHARED_DATA_TYPE_MAP	map	`ESSharedDataType`	是
ES_SHARED_DATA_TYPE_ARRAY	array	`ESSharedDataType`	是

`ESSharedDataParams`

共享数据接口参数

参数	描述	类型	非空
packageName	快应用包名	`string`	是
secretKey	秘钥	`string`	否

接口

`getBoolean`

该方法获取boolean类型共享数据。

完整方法声明：function getBoolean(params: ESSharedDataParams, key: string, defValue: boolean): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
defValue	默认值	`boolean`	是

返回值：

属性	描述	类型	默认值
无	`boolean`类型共享数据	`Promise<boolean>`

`putBoolean`

该方法存储boolean类型共享数据。

完整方法声明：function putBoolean(params: ESSharedDataParams, key: string, value: boolean, mode: ESSharedDataMode): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
value	value	`boolean`	是
mode	共享模式	`ESSharedDataMode`	是

返回值：

属性	描述	类型	默认值
无	是否操作成功	`Promise<boolean>`

`getInt`

该方法获取int类型共享数据。

完整方法声明：function getInt(params: ESSharedDataParams, key: string, defValue: number): Promise<number>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
defValue	默认值	`number`	是

返回值：

属性	描述	类型	默认值
无	`int`类型共享数据	`Promise<number>`

`putInt`

该方法存储int类型共享数据。

完整方法声明：function putInt(params: ESSharedDataParams, key: string, value: number, mode: ESSharedDataMode): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
value	value	`number`	是
mode	共享模式	`ESSharedDataMode`	是

返回值：

属性	描述	类型	默认值
无	是否操作成功	`Promise<boolean>`

`getLong`

该方法获取long类型共享数据。

完整方法声明：function getLong(params: ESSharedDataParams, key: string, defValue: number): Promise<number>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
defValue	默认值	`number`	是

返回值：

属性	描述	类型	默认值
无	`long`类型共享数据	`Promise<number>`

`putLong`

该方法存储long类型共享数据。

完整方法声明：function putLong(params: ESSharedDataParams, key: string, value: number, mode: ESSharedDataMode): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
value	value	`number`	是
mode	共享模式	`ESSharedDataMode`	是

返回值：

属性	描述	类型	默认值
无	是否操作成功	`Promise<boolean>`

`getString`

该方法获取string类型共享数据。

完整方法声明：function getString(params: ESSharedDataParams, key: string, defValue: string | null | undefined): Promise<string>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
defValue	默认值	`string \| null \| undefined`	是

返回值：

属性	描述	类型	默认值
无	`string`类型共享数据	`Promise<string>`

`putString`

该方法存储string类型共享数据。

完整方法声明：function putString(params: ESSharedDataParams, key: string, value: string, mode: ESSharedDataMode): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
value	value	`string`	是
mode	共享模式	`ESSharedDataMode`	是

返回值：

属性	描述	类型	默认值
无	是否操作成功	`Promise<boolean>`

`getArray`

该方法获取Array类型共享数据。

完整方法声明：function getArray(params: ESSharedDataParams, key: string, defValue: Array<any> | null | undefined): Promise<Array<any>>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
defValue	默认值	`Array<any> \| null \| undefined`	是

返回值：

属性	描述	类型	默认值
无	`Array`类型共享数据	`Promise<Array<any>>`

`putArray`

该方法存储Array类型共享数据。

完整方法声明：function putArray(params: ESSharedDataParams, key: string, value: Array<any>, mode: ESSharedDataMode): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
value	value	`Array<any>`	是
mode	共享模式	`ESSharedDataMode`	是

返回值：

属性	描述	类型	默认值
无	是否操作成功	`Promise<boolean>`

`getMap`

该方法获取Map类型共享数据。

完整方法声明：function getMap(params: ESSharedDataParams, key: string, defValue: Map<any, any> | undefined | null): Promise<Map<any, any>>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
defValue	默认值	`Map<any, any> \| undefined \| null`	是

返回值：

属性	描述	类型	默认值
无	`Map`类型共享数据	`Promise<Map<any, any>>`

`putMap`

该方法存储Map类型共享数据。

完整方法声明：function putMap(params: ESSharedDataParams, key: string, value: Map<any, any>, mode: ESSharedDataMode): Promise<boolean>

参数：

参数	描述	类型	非空
params	参数	`ESSharedDataParams`	是
key	key	`string`	是
value	value	`Map<any, any>`	是
mode	共享模式	`ESSharedDataMode`	是

返回值：

属性	描述	类型	默认值
无	是否操作成功	`Promise<boolean>`

基础用法

代码示例：

点击查看源码

TypeScript

vue

<template>
	<div class='es-sdk-root-css'>
		<s-title-view class='es-sdk-content-title-css' :text='this.$options.name' />
		<div class='es-sdk-content-divider-css' />
		<div class='es-sdk-content-column-css'>
			<div class='es-sdk-content-row-css'>
				<s-text-view text='Boolean:'></s-text-view>
				<s-text-view :text='booleanValue'></s-text-view>
				<s-text-view text='Int:'></s-text-view>
				<s-text-view :text='intValue'></s-text-view>
				<s-text-view text='Long:'></s-text-view>
				<s-text-view :text='longValue'></s-text-view>
				<s-text-view text='String:'></s-text-view>
				<s-text-view :text='stringValue'></s-text-view>
				<s-text-view text='Array:'></s-text-view>
				<s-text-view :text='arrayValue'></s-text-view>
				<s-text-view text='Map:'></s-text-view>
				<s-text-view :text='mapValue'></s-text-view>
			</div>
			<div class='es-sdk-content-divider-css' />
			<div class='es-sdk-content-row-css'>
				<s-text-button text='getBoolean' @onButtonClicked='onGetBooleanButtonClicked' />
				<s-text-button text='getInt' @onButtonClicked='onGetIntButtonClicked' />
				<s-text-button text='getLong' @onButtonClicked='onGetLongButtonClicked' />
				<s-text-button text='getString' @onButtonClicked='onGetStringButtonClicked' />
				<s-text-button text='getArray' @onButtonClicked='onGetArrayButtonClicked' />
				<s-text-button text='getMap' @onButtonClicked='onGetMapButtonClicked' />
			</div>
			<div class='es-sdk-content-row-css'>
				<s-text-button text='putBoolean' @onButtonClicked='onPutBooleanButtonClicked' />
				<s-text-button text='putInt' @onButtonClicked='onPutIntButtonClicked' />
				<s-text-button text='putLong' @onButtonClicked='onPutLongButtonClicked' />
				<s-text-button text='putString' @onButtonClicked='onPutStringButtonClicked' />
				<s-text-button text='putArray' @onButtonClicked='onPutArrayButtonClicked' />
				<s-text-button text='putMap' @onButtonClicked='onPutMapButtonClicked' />
			</div>
		</div>
	</div>
</template>

<script lang='ts'>
import {defineComponent} from '@vue/runtime-core';
import {ref} from 'vue';
import {ESSharedDataMode, useESShareData, useESToast} from '@extscreen/es3-core';

export default defineComponent({
	name: '共享数据',
	setup() {
		const booleanValue = ref(false);
		const intValue = ref(0);
		const longValue = ref(0);
		const stringValue = ref('');
		const arrayValue = ref([]);
		const mapValue = ref({});

		const shareData = useESShareData();
		const toast = useESToast();

		const shareDataParams = {
			packageName: 'debug',
			secretKey: '111111111',
		};

		function onGetBooleanButtonClicked() {
			shareData.getBoolean(shareDataParams, 'booleanKey', false)
				.then(value => {
						booleanValue.value = value;
					},
					error => {

					},
				);
		}

		function onGetIntButtonClicked() {
			shareData.getInt(shareDataParams, 'intKey', 0)
				.then(value => {
						intValue.value = value;
					},
					error => {

					},
				);
		}

		function onGetLongButtonClicked() {
			shareData.getLong(shareDataParams, 'longKey', 0)
				.then(value => {
						longValue.value = value;
					},
					error => {

					},
				);
		}

		function onGetStringButtonClicked() {
			shareData.getString(shareDataParams, 'stringKey', '')
				.then(value => {
						stringValue.value = value;
					},
					error => {

					},
				);
		}

		function onGetArrayButtonClicked() {
			shareData.getArray(shareDataParams, 'arrayKey', [])
				.then(value => {
						arrayValue.value = value;
					},
					error => {

					},
				);
		}

		function onGetMapButtonClicked() {
			shareData.getMap(shareDataParams, 'mapKey', null)
				.then(value => {
						mapValue.value = value;
					},
					error => {

					},
				);
		}

		//--------------------------------------------------------------------------------------
		function onPutBooleanButtonClicked() {
			shareData.putBoolean(shareDataParams, 'booleanKey', true,
				ESSharedDataMode.ES_SHARED_DATA_MODE_PRIVATE)
				.then(value => {
						toast.showToast('putSharedBoolean success');
					},
					error => {
						toast.showToast('putSharedBoolean error');
					},
				);

		}

		function onPutIntButtonClicked() {
			shareData.putInt(shareDataParams, 'intKey', 22,
				ESSharedDataMode.ES_SHARED_DATA_MODE_PRIVATE)
				.then(value => {
						toast.showToast('putSharedInt success');
					},
					error => {
						toast.showToast('putSharedInt error');
					},
				);
		}

		function onPutLongButtonClicked() {
			shareData.putLong(shareDataParams, 'longKey', 22,
				ESSharedDataMode.ES_SHARED_DATA_MODE_PRIVATE)
				.then(value => {
						toast.showToast('putSharedLong success');
					},
					error => {
						toast.showToast('putSharedLong error');
					},
				);
		}

		function onPutStringButtonClicked() {
			shareData.putString(shareDataParams, 'stringKey', '22',
				ESSharedDataMode.ES_SHARED_DATA_MODE_PRIVATE)
				.then(value => {
						toast.showToast('putSharedString success');
					},
					error => {
						toast.showToast('putSharedString error');
					},
				);
		}

		function onPutArrayButtonClicked() {
			shareData.putArray(shareDataParams, 'arrayKey', [22],
				ESSharedDataMode.ES_SHARED_DATA_MODE_PRIVATE)
				.then(value => {
						toast.showToast('putSharedArray success');
					},
					error => {
						toast.showToast('putSharedArray error');
					},
				);
		}

		function onPutMapButtonClicked() {

			const map = new Map<string, string>();
			map.set('mapKey', 'mapValue');

			shareData.putMap(shareDataParams, 'mapKey', map,
				ESSharedDataMode.ES_SHARED_DATA_MODE_PRIVATE)
				.then(value => {
						toast.showToast('putSharedMap success');
					},
					error => {
						toast.showToast('putSharedMap error');
					},
				);
		}

		return {
			booleanValue,
			intValue,
			longValue,
			stringValue,
			arrayValue,
			mapValue,
			onGetBooleanButtonClicked,
			onGetIntButtonClicked,
			onGetLongButtonClicked,
			onGetStringButtonClicked,
			onGetArrayButtonClicked,
			onGetMapButtonClicked,
			onPutBooleanButtonClicked,
			onPutIntButtonClicked,
			onPutLongButtonClicked,
			onPutStringButtonClicked,
			onPutArrayButtonClicked,
			onPutMapButtonClicked,
		};
	},
});

</script>

<style>
</style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

共享数据模块 ​

数据结构 ​

ESSharedData ​

ESSharedDataMode ​

ESSharedDataType ​

ESSharedDataParams ​

接口 ​

getBoolean ​

putBoolean ​

getInt ​

putInt ​

getLong ​

putLong ​

getString ​

putString ​

getArray ​

putArray ​

getMap ​

putMap ​

基础用法 ​