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 * @file 18 * @kit BasicServicesKit 19 */ 20 21import { AsyncCallback } from './@ohos.base'; 22 23/** 24 * System time and timezone. 25 * 26 * @namespace systemTime 27 * @syscap SystemCapability.MiscServices.Time 28 * @since 7 29 * @deprecated since 9 30 * @useinstead ohos.systemDateTime 31 */ 32declare namespace systemTime { 33 /** 34 * Sets the system time. 35 * 36 * @permission ohos.permission.SET_TIME 37 * @param { number } time - Target time stamp (ms) 38 * @param { AsyncCallback<void> } callback 39 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 40 * @syscap SystemCapability.MiscServices.Time 41 * @since 7 42 * @deprecated since 9 43 */ 44 function setTime(time: number, callback: AsyncCallback<void>): void; 45 46 /** 47 * Sets the system time. 48 * 49 * @permission ohos.permission.SET_TIME 50 * @param { number } time - Target time stamp (ms) 51 * @returns { Promise<void> } 52 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 53 * @syscap SystemCapability.MiscServices.Time 54 * @since 7 55 * @deprecated since 9 56 */ 57 function setTime(time: number): Promise<void>; 58 59 /** 60 * Obtains the number of milliseconds that have elapsed since the Unix epoch. 61 * 62 * @param { boolean } isNano 63 * @param { AsyncCallback<number> } callback 64 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 65 * @syscap SystemCapability.MiscServices.Time 66 * @since 8 67 * @deprecated since 9 68 * @useinstead ohos.systemDateTime/systemDateTime.getCurrentTime 69 */ 70 function getCurrentTime(isNano: boolean, callback: AsyncCallback<number>): void; 71 72 /** 73 * Obtains the number of milliseconds that have elapsed since the Unix epoch. 74 * 75 * @param { AsyncCallback<number> } callback 76 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 77 * @syscap SystemCapability.MiscServices.Time 78 * @since 8 79 * @deprecated since 9 80 * @useinstead ohos.systemDateTime/systemDateTime.getCurrentTime 81 */ 82 function getCurrentTime(callback: AsyncCallback<number>): void; 83 84 /** 85 * Obtains the number of milliseconds that have elapsed since the Unix epoch. 86 * 87 * @param { boolean } isNano 88 * @returns { Promise<number> } 89 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 90 * @syscap SystemCapability.MiscServices.Time 91 * @since 8 92 * @deprecated since 9 93 * @useinstead ohos.systemDateTime/systemDateTime.getCurrentTime 94 */ 95 function getCurrentTime(isNano?: boolean): Promise<number>; 96 97 /** 98 * Obtains the number of milliseconds elapsed since the system was booted, not including deep sleep time. 99 * 100 * @param { boolean } isNano 101 * @param { AsyncCallback<number> } callback 102 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 103 * @syscap SystemCapability.MiscServices.Time 104 * @since 8 105 * @deprecated since 9 106 * @useinstead ohos.systemDateTime/systemDateTime.getRealActiveTime 107 */ 108 function getRealActiveTime(isNano: boolean, callback: AsyncCallback<number>): void; 109 110 /** 111 * Obtains the number of milliseconds elapsed since the system was booted, not including deep sleep time. 112 * 113 * @param { AsyncCallback<number> } callback 114 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 115 * @syscap SystemCapability.MiscServices.Time 116 * @since 8 117 * @deprecated since 9 118 * @useinstead ohos.systemDateTime/systemDateTime.getRealActiveTime 119 */ 120 function getRealActiveTime(callback: AsyncCallback<number>): void; 121 122 /** 123 * Obtains the number of milliseconds elapsed since the system was booted, not including deep sleep time. 124 * 125 * @param { boolean } isNano 126 * @returns { Promise<number> } 127 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 128 * @syscap SystemCapability.MiscServices.Time 129 * @since 8 130 * @deprecated since 9 131 * @useinstead ohos.systemDateTime/systemDateTime.getRealActiveTime 132 */ 133 function getRealActiveTime(isNano?: boolean): Promise<number>; 134 135 /** 136 * Obtains the number of milliseconds elapsed since the system was booted, including deep sleep time. 137 * 138 * @param { boolean } isNano 139 * @param { AsyncCallback<number> } callback 140 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 141 * @syscap SystemCapability.MiscServices.Time 142 * @since 8 143 * @deprecated since 9 144 * @useinstead ohos.systemDateTime/systemDateTime.getRealTime 145 */ 146 function getRealTime(isNano: boolean, callback: AsyncCallback<number>): void; 147 148 /** 149 * Obtains the number of milliseconds elapsed since the system was booted, including deep sleep time. 150 * 151 * @param { AsyncCallback<number> } callback 152 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 153 * @syscap SystemCapability.MiscServices.Time 154 * @since 8 155 * @deprecated since 9 156 * @useinstead ohos.systemDateTime/systemDateTime.getRealTime 157 */ 158 function getRealTime(callback: AsyncCallback<number>): void; 159 160 /** 161 * Obtains the number of milliseconds elapsed since the system was booted, including deep sleep time. 162 * 163 * @param { boolean } isNano 164 * @returns { Promise<number> } 165 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 166 * @syscap SystemCapability.MiscServices.Time 167 * @since 8 168 * @deprecated since 9 169 * @useinstead ohos.systemDateTime/systemDateTime.getRealTime 170 */ 171 function getRealTime(isNano?: boolean): Promise<number>; 172 173 /** 174 * Sets the system time. 175 * 176 * @permission ohos.permission.SET_TIME 177 * @param { Date } date - The target date 178 * @param { AsyncCallback<void> } callback 179 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 180 * @syscap SystemCapability.MiscServices.Time 181 * @since 7 182 * @deprecated since 9 183 */ 184 function setDate(date: Date, callback: AsyncCallback<void>): void; 185 186 /** 187 * Sets the system time. 188 * 189 * @permission ohos.permission.SET_TIME 190 * @param { Date } date - The target date 191 * @returns { Promise<void> } 192 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 193 * @syscap SystemCapability.MiscServices.Time 194 * @since 7 195 * @deprecated since 9 196 */ 197 function setDate(date: Date): Promise<void>; 198 199 /** 200 * Obtains the system date. 201 * 202 * @param { AsyncCallback<Date> } callback 203 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 204 * @syscap SystemCapability.MiscServices.Time 205 * @since 8 206 * @deprecated since 9 207 * @useinstead ohos.systemDateTime/systemDateTime.getDate 208 */ 209 function getDate(callback: AsyncCallback<Date>): void; 210 211 /** 212 * Obtains the system date. 213 * 214 * @returns { Promise<Date> } 215 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 216 * @syscap SystemCapability.MiscServices.Time 217 * @since 8 218 * @deprecated since 9 219 * @useinstead ohos.systemDateTime/systemDateTime.getDate 220 */ 221 function getDate(): Promise<Date>; 222 223 /** 224 * Sets the system timezone. 225 * 226 * @permission ohos.permission.SET_TIME_ZONE 227 * @param { string } timezone - The system timezone 228 * @param { AsyncCallback<void> } callback 229 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 230 * @syscap SystemCapability.MiscServices.Time 231 * @since 7 232 * @deprecated since 9 233 */ 234 function setTimezone(timezone: string, callback: AsyncCallback<void>): void; 235 236 /** 237 * Sets the system timezone. 238 * 239 * @permission ohos.permission.SET_TIME_ZONE 240 * @param { string } timezone - The system timezone 241 * @returns { Promise<void> } 242 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 243 * @syscap SystemCapability.MiscServices.Time 244 * @since 7 245 * @deprecated since 9 246 */ 247 function setTimezone(timezone: string): Promise<void>; 248 249 /** 250 * Obtains the system timezone. 251 * 252 * @param { AsyncCallback<string> } callback 253 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 254 * @syscap SystemCapability.MiscServices.Time 255 * @since 8 256 * @deprecated since 9 257 * @useinstead ohos.systemDateTime/systemDateTime.getTimezone 258 */ 259 function getTimezone(callback: AsyncCallback<string>): void; 260 261 /** 262 * Obtains the system timezone. 263 * 264 * @returns { Promise<string> } 265 * @throws { BusinessError } -1 - Parameter check failed, permission denied, or system error. 266 * @syscap SystemCapability.MiscServices.Time 267 * @since 8 268 * @deprecated since 9 269 * @useinstead ohos.systemDateTime/systemDateTime.getTimezone 270 */ 271 function getTimezone(): Promise<string>; 272} 273 274export default systemTime;