1/* 2 * Copyright (c) 2021-2023 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 ArkUI 19 */ 20 21/** 22 * The challenge result based on input pattern for control pattern lock component. 23 * @enum { number } 24 * @syscap SystemCapability.ArkUI.ArkUI.Full 25 * @crossplatform 26 * @since 11 27 */ 28/** 29 * The challenge result based on input pattern for control pattern lock component. 30 * @enum { number } 31 * @syscap SystemCapability.ArkUI.ArkUI.Full 32 * @crossplatform 33 * @atomicservice 34 * @since 12 35 */ 36declare enum PatternLockChallengeResult { 37 /** 38 * The challenge result is correct. 39 * @syscap SystemCapability.ArkUI.ArkUI.Full 40 * @crossplatform 41 * @since 11 42 */ 43 /** 44 * The challenge result is correct. 45 * @syscap SystemCapability.ArkUI.ArkUI.Full 46 * @crossplatform 47 * @atomicservice 48 * @since 12 49 */ 50 CORRECT = 1, 51 /** 52 * The challenge result is wrong. 53 * @syscap SystemCapability.ArkUI.ArkUI.Full 54 * @crossplatform 55 * @since 11 56 */ 57 /** 58 * The challenge result is wrong. 59 * @syscap SystemCapability.ArkUI.ArkUI.Full 60 * @crossplatform 61 * @atomicservice 62 * @since 12 63 */ 64 WRONG = 2 65} 66 67/** 68 * Defines the options of active circle style. 69 * 70 * @interface CircleStyleOptions 71 * @syscap SystemCapability.ArkUI.ArkUI.Full 72 * @crossplatform 73 * @atomicservice 74 * @since 12 75 */ 76declare interface CircleStyleOptions { 77 /** 78 * The circle color when cell is active state. 79 * 80 * @type { ?ResourceColor } 81 * @syscap SystemCapability.ArkUI.ArkUI.Full 82 * @crossplatform 83 * @atomicservice 84 * @since 12 85 */ 86 color?: ResourceColor; 87 88 /** 89 * The circle radius when cell is active state. 90 * 91 * @type { ?LengthMetrics } 92 * @syscap SystemCapability.ArkUI.ArkUI.Full 93 * @crossplatform 94 * @atomicservice 95 * @since 12 96 */ 97 radius?: LengthMetrics; 98 99 /** 100 * Enable the wave effect when cell is active. 101 * 102 * @type { ?boolean } 103 * @syscap SystemCapability.ArkUI.ArkUI.Full 104 * @crossplatform 105 * @atomicservice 106 * @since 12 107 */ 108 enableWaveEffect?: boolean; 109} 110 111/** 112 * Provides methods for control pattern lock component. 113 * 114 * @syscap SystemCapability.ArkUI.ArkUI.Full 115 * @since 9 116 */ 117/** 118 * Provides methods for control pattern lock component. 119 * 120 * @syscap SystemCapability.ArkUI.ArkUI.Full 121 * @crossplatform 122 * @since 10 123 */ 124/** 125 * Provides methods for control pattern lock component. 126 * 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @crossplatform 129 * @atomicservice 130 * @since 12 131 */ 132declare class PatternLockController { 133 /** 134 * constructor. 135 * 136 * @syscap SystemCapability.ArkUI.ArkUI.Full 137 * @since 9 138 */ 139 /** 140 * constructor. 141 * 142 * @syscap SystemCapability.ArkUI.ArkUI.Full 143 * @crossplatform 144 * @since 10 145 */ 146 /** 147 * constructor. 148 * 149 * @syscap SystemCapability.ArkUI.ArkUI.Full 150 * @crossplatform 151 * @atomicservice 152 * @since 12 153 */ 154 constructor(); 155 156 /** 157 * Reset pattern lock. 158 * 159 * @syscap SystemCapability.ArkUI.ArkUI.Full 160 * @since 9 161 */ 162 /** 163 * Reset pattern lock. 164 * 165 * @syscap SystemCapability.ArkUI.ArkUI.Full 166 * @crossplatform 167 * @since 10 168 */ 169 /** 170 * Reset pattern lock. 171 * 172 * @syscap SystemCapability.ArkUI.ArkUI.Full 173 * @crossplatform 174 * @atomicservice 175 * @since 12 176 */ 177 reset(); 178 179 /** 180 * Set challenge result. 181 * @param { PatternLockChallengeResult } result - The challenge result based on input pattern. 182 * @syscap SystemCapability.ArkUI.ArkUI.Full 183 * @crossplatform 184 * @since 11 185 */ 186 /** 187 * Set challenge result. 188 * @param { PatternLockChallengeResult } result - The challenge result based on input pattern. 189 * @syscap SystemCapability.ArkUI.ArkUI.Full 190 * @crossplatform 191 * @atomicservice 192 * @since 12 193 */ 194 setChallengeResult(result: PatternLockChallengeResult): void; 195} 196 197/** 198 * Provides an interface for generating PatternLock. 199 * 200 * @interface PatternLockInterface 201 * @syscap SystemCapability.ArkUI.ArkUI.Full 202 * @since 9 203 */ 204/** 205 * Provides an interface for generating PatternLock. 206 * 207 * @interface PatternLockInterface 208 * @syscap SystemCapability.ArkUI.ArkUI.Full 209 * @crossplatform 210 * @since 10 211 */ 212/** 213 * Provides an interface for generating PatternLock. 214 * 215 * @interface PatternLockInterface 216 * @syscap SystemCapability.ArkUI.ArkUI.Full 217 * @crossplatform 218 * @atomicservice 219 * @since 12 220 */ 221interface PatternLockInterface { 222 /** 223 * Constructor. 224 * 225 * @param { PatternLockController } [controller] - controller 226 * @returns { PatternLockAttribute } 227 * @syscap SystemCapability.ArkUI.ArkUI.Full 228 * @since 9 229 */ 230 /** 231 * Constructor. 232 * 233 * @param { PatternLockController } [controller] controller 234 * @returns { PatternLockAttribute } 235 * @syscap SystemCapability.ArkUI.ArkUI.Full 236 * @crossplatform 237 * @since 10 238 */ 239 /** 240 * Constructor. 241 * 242 * @param { PatternLockController } [controller] controller 243 * @returns { PatternLockAttribute } 244 * @syscap SystemCapability.ArkUI.ArkUI.Full 245 * @crossplatform 246 * @atomicservice 247 * @since 12 248 */ 249 (controller?: PatternLockController): PatternLockAttribute; 250} 251 252/** 253 * Provides methods for attribute pattern lock component. 254 * 255 * @extends CommonMethod<PatternLockAttribute> 256 * @syscap SystemCapability.ArkUI.ArkUI.Full 257 * @since 9 258 */ 259/** 260 * Provides methods for attribute pattern lock component. 261 * 262 * @extends CommonMethod<PatternLockAttribute> 263 * @syscap SystemCapability.ArkUI.ArkUI.Full 264 * @crossplatform 265 * @since 10 266 */ 267/** 268 * Provides methods for attribute pattern lock component. 269 * 270 * @extends CommonMethod<PatternLockAttribute> 271 * @syscap SystemCapability.ArkUI.ArkUI.Full 272 * @crossplatform 273 * @atomicservice 274 * @since 12 275 */ 276declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> { 277 /** 278 * The square side length of pattern lock component. 279 * 280 * @param { Length } value 281 * @returns { PatternLockAttribute } 282 * @syscap SystemCapability.ArkUI.ArkUI.Full 283 * @since 9 284 */ 285 /** 286 * The square side length of pattern lock component. 287 * 288 * @param { Length } value 289 * @returns { PatternLockAttribute } 290 * @syscap SystemCapability.ArkUI.ArkUI.Full 291 * @crossplatform 292 * @since 10 293 */ 294 /** 295 * The square side length of pattern lock component. 296 * 297 * @param { Length } value 298 * @returns { PatternLockAttribute } 299 * @syscap SystemCapability.ArkUI.ArkUI.Full 300 * @crossplatform 301 * @atomicservice 302 * @since 12 303 */ 304 sideLength(value: Length): PatternLockAttribute; 305 306 /** 307 * Circle radius. 308 * 309 * @param { Length } value 310 * @returns { PatternLockAttribute } 311 * @syscap SystemCapability.ArkUI.ArkUI.Full 312 * @since 9 313 */ 314 /** 315 * Circle radius. 316 * 317 * @param { Length } value 318 * @returns { PatternLockAttribute } 319 * @syscap SystemCapability.ArkUI.ArkUI.Full 320 * @crossplatform 321 * @since 10 322 */ 323 /** 324 * Circle radius. 325 * 326 * @param { Length } value 327 * @returns { PatternLockAttribute } 328 * @syscap SystemCapability.ArkUI.ArkUI.Full 329 * @crossplatform 330 * @atomicservice 331 * @since 12 332 */ 333 circleRadius(value: Length): PatternLockAttribute; 334 335 /** 336 * The background color. 337 * 338 * @param { ResourceColor } value 339 * @returns { PatternLockAttribute } 340 * @syscap SystemCapability.ArkUI.ArkUI.Full 341 * @since 9 342 */ 343 /** 344 * The background color. 345 * 346 * @param { ResourceColor } value 347 * @returns { PatternLockAttribute } 348 * @syscap SystemCapability.ArkUI.ArkUI.Full 349 * @crossplatform 350 * @since 10 351 */ 352 /** 353 * The background color. 354 * 355 * @param { ResourceColor } value 356 * @returns { PatternLockAttribute } 357 * @syscap SystemCapability.ArkUI.ArkUI.Full 358 * @crossplatform 359 * @atomicservice 360 * @since 12 361 */ 362 backgroundColor(value: ResourceColor): PatternLockAttribute; 363 364 /** 365 * Regular color. 366 * 367 * @param { ResourceColor } value 368 * @returns { PatternLockAttribute } 369 * @syscap SystemCapability.ArkUI.ArkUI.Full 370 * @since 9 371 */ 372 /** 373 * Regular color. 374 * 375 * @param { ResourceColor } value 376 * @returns { PatternLockAttribute } 377 * @syscap SystemCapability.ArkUI.ArkUI.Full 378 * @crossplatform 379 * @since 10 380 */ 381 /** 382 * Regular color. 383 * 384 * @param { ResourceColor } value 385 * @returns { PatternLockAttribute } 386 * @syscap SystemCapability.ArkUI.ArkUI.Full 387 * @crossplatform 388 * @atomicservice 389 * @since 12 390 */ 391 regularColor(value: ResourceColor): PatternLockAttribute; 392 393 /** 394 * The color when cell is selected. 395 * 396 * @param { ResourceColor } value 397 * @returns { PatternLockAttribute } 398 * @syscap SystemCapability.ArkUI.ArkUI.Full 399 * @since 9 400 */ 401 /** 402 * The color when cell is selected. 403 * 404 * @param { ResourceColor } value 405 * @returns { PatternLockAttribute } 406 * @syscap SystemCapability.ArkUI.ArkUI.Full 407 * @crossplatform 408 * @since 10 409 */ 410 /** 411 * The color when cell is selected. 412 * 413 * @param { ResourceColor } value 414 * @returns { PatternLockAttribute } 415 * @syscap SystemCapability.ArkUI.ArkUI.Full 416 * @crossplatform 417 * @atomicservice 418 * @since 12 419 */ 420 selectedColor(value: ResourceColor): PatternLockAttribute; 421 422 /** 423 * The color when cell is active state. 424 * 425 * @param { ResourceColor } value 426 * @returns { PatternLockAttribute } 427 * @syscap SystemCapability.ArkUI.ArkUI.Full 428 * @since 9 429 */ 430 /** 431 * The color when cell is active state. 432 * 433 * @param { ResourceColor } value 434 * @returns { PatternLockAttribute } 435 * @syscap SystemCapability.ArkUI.ArkUI.Full 436 * @crossplatform 437 * @since 10 438 */ 439 /** 440 * The color when cell is active state. 441 * 442 * @param { ResourceColor } value 443 * @returns { PatternLockAttribute } 444 * @syscap SystemCapability.ArkUI.ArkUI.Full 445 * @crossplatform 446 * @atomicservice 447 * @since 12 448 */ 449 activeColor(value: ResourceColor): PatternLockAttribute; 450 451 /** 452 * The path line color. 453 * 454 * @param { ResourceColor } value 455 * @returns { PatternLockAttribute } 456 * @syscap SystemCapability.ArkUI.ArkUI.Full 457 * @since 9 458 */ 459 /** 460 * The path line color. 461 * 462 * @param { ResourceColor } value 463 * @returns { PatternLockAttribute } 464 * @syscap SystemCapability.ArkUI.ArkUI.Full 465 * @crossplatform 466 * @since 10 467 */ 468 /** 469 * The path line color. 470 * 471 * @param { ResourceColor } value 472 * @returns { PatternLockAttribute } 473 * @syscap SystemCapability.ArkUI.ArkUI.Full 474 * @crossplatform 475 * @atomicservice 476 * @since 12 477 */ 478 pathColor(value: ResourceColor): PatternLockAttribute; 479 480 /** 481 * The path line stroke width. 482 * 483 * @param { number | string } value 484 * @returns { PatternLockAttribute } 485 * @syscap SystemCapability.ArkUI.ArkUI.Full 486 * @since 9 487 */ 488 /** 489 * The path line stroke width. 490 * 491 * @param { number | string } value 492 * @returns { PatternLockAttribute } 493 * @syscap SystemCapability.ArkUI.ArkUI.Full 494 * @crossplatform 495 * @since 10 496 */ 497 /** 498 * The path line stroke width. 499 * 500 * @param { number | string } value 501 * @returns { PatternLockAttribute } 502 * @syscap SystemCapability.ArkUI.ArkUI.Full 503 * @crossplatform 504 * @atomicservice 505 * @since 12 506 */ 507 pathStrokeWidth(value: number | string): PatternLockAttribute; 508 509 /** 510 * Called when the pattern input completed. 511 * 512 * @param { function } callback 513 * @returns { PatternLockAttribute } 514 * @syscap SystemCapability.ArkUI.ArkUI.Full 515 * @since 9 516 */ 517 /** 518 * Called when the pattern input completed. 519 * 520 * @param { function } callback 521 * @returns { PatternLockAttribute } 522 * @syscap SystemCapability.ArkUI.ArkUI.Full 523 * @crossplatform 524 * @since 10 525 */ 526 /** 527 * Called when the pattern input completed. 528 * 529 * @param { function } callback 530 * @returns { PatternLockAttribute } 531 * @syscap SystemCapability.ArkUI.ArkUI.Full 532 * @crossplatform 533 * @atomicservice 534 * @since 12 535 */ 536 onPatternComplete(callback: (input: Array<number>) => void): PatternLockAttribute; 537 538 /** 539 * Called when judging whether the input state can be reset by touch pattern lock. 540 * 541 * @param { boolean } value 542 * @returns { PatternLockAttribute } 543 * @syscap SystemCapability.ArkUI.ArkUI.Full 544 * @since 9 545 */ 546 /** 547 * Called when judging whether the input state can be reset by touch pattern lock. 548 * 549 * @param { boolean } value 550 * @returns { PatternLockAttribute } 551 * @syscap SystemCapability.ArkUI.ArkUI.Full 552 * @crossplatform 553 * @since 10 554 */ 555 /** 556 * Called when judging whether the input state can be reset by touch pattern lock. 557 * 558 * @param { boolean } value 559 * @returns { PatternLockAttribute } 560 * @syscap SystemCapability.ArkUI.ArkUI.Full 561 * @crossplatform 562 * @atomicservice 563 * @since 12 564 */ 565 autoReset(value: boolean): PatternLockAttribute; 566 567 /** 568 * Called when connecting to a grid dot. 569 * @param { import('../api/@ohos.base').Callback<number> } callback - A callback instance used when connection to a grid dot. 570 * @returns { PatternLockAttribute } 571 * @syscap SystemCapability.ArkUI.ArkUI.Full 572 * @crossplatform 573 * @since 11 574 */ 575 /** 576 * Called when connecting to a grid dot. 577 * @param { import('../api/@ohos.base').Callback<number> } callback - A callback instance used when connection to a grid dot. 578 * @returns { PatternLockAttribute } 579 * @syscap SystemCapability.ArkUI.ArkUI.Full 580 * @crossplatform 581 * @atomicservice 582 * @since 12 583 */ 584 onDotConnect(callback: import('../api/@ohos.base').Callback<number>): PatternLockAttribute; 585 586 /** 587 * The activate circle style. 588 * 589 * @param { Optional<CircleStyleOptions> } options - the circle style setting options 590 * @returns { PatternLockAttribute } PatternLockAttribute 591 * @syscap SystemCapability.ArkUI.ArkUI.Full 592 * @crossplatform 593 * @atomicservice 594 * @since 12 595 */ 596 activateCircleStyle(options: Optional<CircleStyleOptions>): PatternLockAttribute; 597} 598 599/** 600 * Defines PatternLock Component. 601 * 602 * @syscap SystemCapability.ArkUI.ArkUI.Full 603 * @since 9 604 */ 605/** 606 * Defines PatternLock Component. 607 * 608 * @syscap SystemCapability.ArkUI.ArkUI.Full 609 * @crossplatform 610 * @since 10 611 */ 612/** 613 * Defines PatternLock Component. 614 * 615 * @syscap SystemCapability.ArkUI.ArkUI.Full 616 * @crossplatform 617 * @atomicservice 618 * @since 12 619 */ 620declare const PatternLock: PatternLockInterface; 621 622/** 623 * Defines PatternLock Component instance. 624 * 625 * @syscap SystemCapability.ArkUI.ArkUI.Full 626 * @since 9 627 */ 628/** 629 * Defines PatternLock Component instance. 630 * 631 * @syscap SystemCapability.ArkUI.ArkUI.Full 632 * @crossplatform 633 * @since 10 634 */ 635/** 636 * Defines PatternLock Component instance. 637 * 638 * @syscap SystemCapability.ArkUI.ArkUI.Full 639 * @crossplatform 640 * @atomicservice 641 * @since 12 642 */ 643declare const PatternLockInstance: PatternLockAttribute; 644