• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * A static class pertaining to the product information.
18 *
19 * @since 6
20 * @syscap SystemCapability.Startup.SystemInfo
21 */
22declare namespace deviceInfo {
23     /**
24     * Obtains the device type represented by a string,
25     * which can be {@code phone} (or {@code default} for phones), {@code wearable}, {@code liteWearable},
26     * {@code tablet}, {@code tv}, {@code car}, or {@code smartVision}.
27     * @syscap SystemCapability.Startup.SystemInfo
28     * @since 6
29     */
30    const deviceType: string;
31
32    /**
33     * Obtains the device manufacturer represented by a string.
34     * @syscap SystemCapability.Startup.SystemInfo
35     * @since 6
36     */
37    const manufacture: string;
38
39    /**
40     * Obtains the device brand represented by a string.
41     * @syscap SystemCapability.Startup.SystemInfo
42     * @since 6
43     */
44    const brand: string;
45
46    /**
47     * Obtains the external product series represented by a string.
48     * @syscap SystemCapability.Startup.SystemInfo
49     * @since 6
50     */
51    const marketName: string;
52
53    /**
54     * Obtains the product series represented by a string.
55     * @syscap SystemCapability.Startup.SystemInfo
56     * @since 6
57     */
58    const productSeries: string;
59
60    /**
61     * Obtains the product model represented by a string.
62     * @syscap SystemCapability.Startup.SystemInfo
63     * @since 6
64     */
65    const productModel: string;
66
67    /**
68     * Obtains the software model represented by a string.
69     * @syscap SystemCapability.Startup.SystemInfo
70     * @since 6
71     */
72    const softwareModel: string;
73
74    /**
75     * Obtains the hardware model represented by a string.
76     * @syscap SystemCapability.Startup.SystemInfo
77     * @since 6
78     */
79    const hardwareModel: string;
80
81    /**
82     * Obtains the hardware profile represented by a string.
83     * @syscap SystemCapability.Startup.SystemInfo
84     * @since 6
85     */
86    const hardwareProfile: string;
87
88    /**
89     * Obtains the device serial number represented by a string.
90     * @syscap SystemCapability.Startup.SystemInfo
91     * @since 6
92     */
93    const serial: string;
94
95    /**
96     * Obtains the bootloader version number represented by a string.
97     * @syscap SystemCapability.Startup.SystemInfo
98     * @since 6
99     */
100    const bootloaderVersion: string;
101
102    /**
103     * Obtains the application binary interface (Abi) list represented by a string.
104     * @syscap SystemCapability.Startup.SystemInfo
105     * @since 6
106     */
107    const abiList: string;
108
109    /**
110     * Obtains the security patch level represented by a string.
111     * @syscap SystemCapability.Startup.SystemInfo
112     * @since 6
113     */
114    const securityPatchTag: string;
115
116    /**
117     * Obtains the product version represented by a string.
118     * @syscap SystemCapability.Startup.SystemInfo
119     * @since 6
120     */
121    const displayVersion: string;
122
123    /**
124     * Obtains the incremental version represented by a string.
125     * @syscap SystemCapability.Startup.SystemInfo
126     * @since 6
127     */
128    const incrementalVersion: string;
129
130    /**
131     * Obtains the OS release type represented by a string.
132     *
133     * <p>The OS release category can be {@code Release}, {@code Beta}, or {@code Canary}.
134     * The specific release type may be {@code Release}, {@code Beta1}, or others alike.
135     * @syscap SystemCapability.Startup.SystemInfo
136     * @since 6
137     */
138    const osReleaseType: string;
139
140    /**
141     * Obtains the OS version represented by a string.
142     * @syscap SystemCapability.Startup.SystemInfo
143     * @since 6
144     */
145    const osFullName: string;
146
147    /**
148     * Obtains the major (M) version number, which increases with any updates to the overall architecture.
149     * <p>The M version number monotonically increases from 1 to 99.
150     * @syscap SystemCapability.Startup.SystemInfo
151     * @since 6
152     */
153    const majorVersion: number;
154
155    /**
156     * Obtains the senior (S) version number, which increases with any updates to the partial
157     * architecture or major features.
158     * <p>The S version number monotonically increases from 0 to 99.
159     * @syscap SystemCapability.Startup.SystemInfo
160     * @since 6
161     */
162    const seniorVersion: number;
163
164    /**
165     * Obtains the feature (F) version number, which increases with any planned new features.
166     * <p>The F version number monotonically increases from 0 or 1 to 99.
167     * @syscap SystemCapability.Startup.SystemInfo
168     * @since 6
169     */
170    const featureVersion: number;
171
172    /**
173     * Obtains the build (B) version number, which increases with each new development build.
174     * <p>The B version number monotonically increases from 0 or 1 to 999.
175     * @syscap SystemCapability.Startup.SystemInfo
176     * @since 6
177     */
178    const buildVersion: number;
179
180    /**
181     * Obtains the SDK API version number.
182     * @syscap SystemCapability.Startup.SystemInfo
183     * @since 6
184     */
185    const sdkApiVersion: number;
186
187    /**
188     * Obtains the first API version number.
189     * @syscap SystemCapability.Startup.SystemInfo
190     * @since 6
191     */
192    const firstApiVersion: number;
193
194    /**
195     * Obtains the version ID by a string.
196     * @syscap SystemCapability.Startup.SystemInfo
197     * @since 6
198     */
199    const versionId: string;
200
201    /**
202     * Obtains the build types of the same baseline code.
203     * @syscap SystemCapability.Startup.SystemInfo
204     * @since 6
205     */
206    const buildType: string;
207
208    /**
209     * Obtains the different build user of the same baseline code.
210     * @syscap SystemCapability.Startup.SystemInfo
211     * @since 6
212     */
213    const buildUser: string;
214
215    /**
216     * Obtains the different build host of the same baseline code.
217     * @syscap SystemCapability.Startup.SystemInfo
218     * @since 6
219     */
220    const buildHost: string;
221
222    /**
223     * Obtains the build time.
224     * @syscap SystemCapability.Startup.SystemInfo
225     * @since 6
226     */
227    const buildTime: string;
228
229    /**
230     * Obtains the version hash.
231     * @syscap SystemCapability.Startup.SystemInfo
232     * @since 6
233     */
234    const buildRootHash: string;
235    /**
236     * Obtains the device udid.
237     * @syscap SystemCapability.Startup.SystemInfo
238     * @since 7
239     */
240    const udid: string;
241
242}
243
244export default deviceInfo;
245