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