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