1/* 2 * Copyright (c) 2021-2024 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 LocalizationKit 19 */ 20 21import { RawFileDescriptor as _RawFileDescriptor } from './global/rawFileDescriptor'; 22import { Resource as _Resource } from './global/resource'; 23import { AsyncCallback as _AsyncCallback } from './@ohos.base'; 24import { DrawableDescriptor } from './@ohos.arkui.drawableDescriptor'; 25 26/** 27 * Provides resource related APIs. 28 * 29 * @namespace resourceManager 30 * @syscap SystemCapability.Global.ResourceManager 31 * @since 6 32 */ 33/** 34 * Provides resource related APIs. 35 * 36 * @namespace resourceManager 37 * @syscap SystemCapability.Global.ResourceManager 38 * @crossplatform 39 * @since 10 40 */ 41/** 42 * Provides resource related APIs. 43 * 44 * @namespace resourceManager 45 * @syscap SystemCapability.Global.ResourceManager 46 * @crossplatform 47 * @atomicservice 48 * @since 11 49 */ 50declare namespace resourceManager { 51 /** 52 * Enumerates screen directions. 53 * 54 * @enum { number } 55 * @syscap SystemCapability.Global.ResourceManager 56 * @since 6 57 */ 58 /** 59 * Enumerates screen directions. 60 * 61 * @enum { number } 62 * @syscap SystemCapability.Global.ResourceManager 63 * @crossplatform 64 * @since 10 65 */ 66 /** 67 * Enumerates screen directions. 68 * 69 * @enum { number } 70 * @syscap SystemCapability.Global.ResourceManager 71 * @crossplatform 72 * @atomicservice 73 * @since 11 74 */ 75 export enum Direction { 76 /** 77 * Indicates the vertical direction. 78 * 79 * @syscap SystemCapability.Global.ResourceManager 80 * @since 6 81 */ 82 /** 83 * Indicates the vertical direction. 84 * 85 * @syscap SystemCapability.Global.ResourceManager 86 * @crossplatform 87 * @since 10 88 */ 89 /** 90 * Indicates the vertical direction. 91 * 92 * @syscap SystemCapability.Global.ResourceManager 93 * @crossplatform 94 * @atomicservice 95 * @since 11 96 */ 97 DIRECTION_VERTICAL = 0, 98 99 /** 100 * Indicates the horizontal direction. 101 * 102 * @syscap SystemCapability.Global.ResourceManager 103 * @since 6 104 */ 105 /** 106 * Indicates the horizontal direction. 107 * 108 * @syscap SystemCapability.Global.ResourceManager 109 * @crossplatform 110 * @since 10 111 */ 112 /** 113 * Indicates the horizontal direction. 114 * 115 * @syscap SystemCapability.Global.ResourceManager 116 * @crossplatform 117 * @atomicservice 118 * @since 11 119 */ 120 DIRECTION_HORIZONTAL = 1 121 } 122 123 /** 124 * Enumerates device types. 125 * 126 * @enum { number } 127 * @syscap SystemCapability.Global.ResourceManager 128 * @since 6 129 */ 130 /** 131 * Enumerates device types. 132 * 133 * @enum { number } 134 * @syscap SystemCapability.Global.ResourceManager 135 * @crossplatform 136 * @since 10 137 */ 138 /** 139 * Enumerates device types. 140 * 141 * @enum { number } 142 * @syscap SystemCapability.Global.ResourceManager 143 * @crossplatform 144 * @atomicservice 145 * @since 11 146 */ 147 export enum DeviceType { 148 /** 149 * Indicates a phone. 150 * 151 * @syscap SystemCapability.Global.ResourceManager 152 * @since 6 153 */ 154 /** 155 * Indicates a phone. 156 * 157 * @syscap SystemCapability.Global.ResourceManager 158 * @crossplatform 159 * @since 10 160 */ 161 /** 162 * Indicates a phone. 163 * 164 * @syscap SystemCapability.Global.ResourceManager 165 * @crossplatform 166 * @atomicservice 167 * @since 11 168 */ 169 DEVICE_TYPE_PHONE = 0x00, 170 171 /** 172 * Indicates a tablet. 173 * 174 * @syscap SystemCapability.Global.ResourceManager 175 * @since 6 176 */ 177 /** 178 * Indicates a tablet. 179 * 180 * @syscap SystemCapability.Global.ResourceManager 181 * @since 10 182 */ 183 /** 184 * Indicates a tablet. 185 * 186 * @syscap SystemCapability.Global.ResourceManager 187 * @crossplatform 188 * @atomicservice 189 * @since 11 190 */ 191 DEVICE_TYPE_TABLET = 0x01, 192 193 /** 194 * Indicates a car. 195 * 196 * @syscap SystemCapability.Global.ResourceManager 197 * @since 6 198 */ 199 /** 200 * Indicates a car. 201 * 202 * @syscap SystemCapability.Global.ResourceManager 203 * @since 10 204 */ 205 /** 206 * Indicates a car. 207 * 208 * @syscap SystemCapability.Global.ResourceManager 209 * @crossplatform 210 * @atomicservice 211 * @since 11 212 */ 213 DEVICE_TYPE_CAR = 0x02, 214 215 /** 216 * Indicates a PC. 217 * 218 * @syscap SystemCapability.Global.ResourceManager 219 * @since 6 220 */ 221 /** 222 * Indicates a PC. 223 * 224 * @syscap SystemCapability.Global.ResourceManager 225 * @since 10 226 */ 227 /** 228 * Indicates a PC. 229 * 230 * @syscap SystemCapability.Global.ResourceManager 231 * @crossplatform 232 * @atomicservice 233 * @since 11 234 */ 235 DEVICE_TYPE_PC = 0x03, 236 237 /** 238 * Indicates a smart TV. 239 * 240 * @syscap SystemCapability.Global.ResourceManager 241 * @since 6 242 */ 243 /** 244 * Indicates a smart TV. 245 * 246 * @syscap SystemCapability.Global.ResourceManager 247 * @since 10 248 */ 249 /** 250 * Indicates a smart TV. 251 * 252 * @syscap SystemCapability.Global.ResourceManager 253 * @crossplatform 254 * @atomicservice 255 * @since 11 256 */ 257 DEVICE_TYPE_TV = 0x04, 258 259 /** 260 * Indicates a wearable device. 261 * 262 * @syscap SystemCapability.Global.ResourceManager 263 * @since 6 264 */ 265 /** 266 * Indicates a wearable device. 267 * 268 * @syscap SystemCapability.Global.ResourceManager 269 * @since 10 270 */ 271 /** 272 * Indicates a wearable device. 273 * 274 * @syscap SystemCapability.Global.ResourceManager 275 * @crossplatform 276 * @atomicservice 277 * @since 11 278 */ 279 DEVICE_TYPE_WEARABLE = 0x06, 280 281 /** 282 * Indicates a 2in1 device. 283 * 284 * @syscap SystemCapability.Global.ResourceManager 285 * @crossplatform 286 * @atomicservice 287 * @since 11 288 */ 289 DEVICE_TYPE_2IN1 = 0x07 290 } 291 292 /** 293 * Enumerates screen density types. 294 * 295 * @enum { number } 296 * @syscap SystemCapability.Global.ResourceManager 297 * @since 6 298 */ 299 /** 300 * Enumerates screen density types. 301 * 302 * @enum { number } 303 * @syscap SystemCapability.Global.ResourceManager 304 * @crossplatform 305 * @since 10 306 */ 307 /** 308 * Enumerates screen density types. 309 * 310 * @enum { number } 311 * @syscap SystemCapability.Global.ResourceManager 312 * @crossplatform 313 * @atomicservice 314 * @since 11 315 */ 316 export enum ScreenDensity { 317 /** 318 * Indicates small screen density. 319 * 320 * @syscap SystemCapability.Global.ResourceManager 321 * @since 6 322 */ 323 /** 324 * Indicates small screen density. 325 * 326 * @syscap SystemCapability.Global.ResourceManager 327 * @crossplatform 328 * @since 10 329 */ 330 /** 331 * Indicates small screen density. 332 * 333 * @syscap SystemCapability.Global.ResourceManager 334 * @crossplatform 335 * @atomicservice 336 * @since 11 337 */ 338 SCREEN_SDPI = 120, 339 340 /** 341 * Indicates medium screen density. 342 * 343 * @syscap SystemCapability.Global.ResourceManager 344 * @since 6 345 */ 346 /** 347 * Indicates medium screen density. 348 * 349 * @syscap SystemCapability.Global.ResourceManager 350 * @crossplatform 351 * @since 10 352 */ 353 /** 354 * Indicates medium screen density. 355 * 356 * @syscap SystemCapability.Global.ResourceManager 357 * @crossplatform 358 * @atomicservice 359 * @since 11 360 */ 361 SCREEN_MDPI = 160, 362 363 /** 364 * Indicates large screen density. 365 * 366 * @syscap SystemCapability.Global.ResourceManager 367 * @since 6 368 */ 369 /** 370 * Indicates large screen density. 371 * 372 * @syscap SystemCapability.Global.ResourceManager 373 * @crossplatform 374 * @since 10 375 */ 376 /** 377 * Indicates large screen density. 378 * 379 * @syscap SystemCapability.Global.ResourceManager 380 * @crossplatform 381 * @atomicservice 382 * @since 11 383 */ 384 SCREEN_LDPI = 240, 385 386 /** 387 * Indicates extra-large screen density. 388 * 389 * @syscap SystemCapability.Global.ResourceManager 390 * @since 6 391 */ 392 /** 393 * Indicates extra-large screen density. 394 * 395 * @syscap SystemCapability.Global.ResourceManager 396 * @crossplatform 397 * @since 10 398 */ 399 /** 400 * Indicates extra-large screen density. 401 * 402 * @syscap SystemCapability.Global.ResourceManager 403 * @crossplatform 404 * @atomicservice 405 * @since 11 406 */ 407 SCREEN_XLDPI = 320, 408 409 /** 410 * Indicates extra-extra-large screen density. 411 * 412 * @syscap SystemCapability.Global.ResourceManager 413 * @since 6 414 */ 415 /** 416 * Indicates extra-extra-large screen density. 417 * 418 * @syscap SystemCapability.Global.ResourceManager 419 * @crossplatform 420 * @since 10 421 */ 422 /** 423 * Indicates extra-extra-large screen density. 424 * 425 * @syscap SystemCapability.Global.ResourceManager 426 * @crossplatform 427 * @atomicservice 428 * @since 11 429 */ 430 SCREEN_XXLDPI = 480, 431 432 /** 433 * Indicates extra-extra-extra-large screen density. 434 * 435 * @syscap SystemCapability.Global.ResourceManager 436 * @since 6 437 */ 438 /** 439 * Indicates extra-extra-extra-large screen density. 440 * 441 * @syscap SystemCapability.Global.ResourceManager 442 * @crossplatform 443 * @since 10 444 */ 445 /** 446 * Indicates extra-extra-extra-large screen density. 447 * 448 * @syscap SystemCapability.Global.ResourceManager 449 * @crossplatform 450 * @atomicservice 451 * @since 11 452 */ 453 SCREEN_XXXLDPI = 640 454 } 455 456 /** 457 * Enumerates color mode types. 458 * 459 * @enum { number } 460 * @syscap SystemCapability.Global.ResourceManager 461 * @crossplatform 462 * @atomicservice 463 * @since 12 464 */ 465 export enum ColorMode { 466 467 /** 468 * Indicates dark mode. 469 * 470 * @syscap SystemCapability.Global.ResourceManager 471 * @crossplatform 472 * @atomicservice 473 * @since 12 474 */ 475 DARK = 0, 476 477 /** 478 * Indicates light mode. 479 * 480 * @syscap SystemCapability.Global.ResourceManager 481 * @crossplatform 482 * @atomicservice 483 * @since 12 484 */ 485 LIGHT = 1 486 } 487 488 /** 489 * Provides the device configuration. 490 * 491 * @syscap SystemCapability.Global.ResourceManager 492 * @since 6 493 */ 494 /** 495 * Provides the device configuration. 496 * 497 * @syscap SystemCapability.Global.ResourceManager 498 * @crossplatform 499 * @since 10 500 */ 501 /** 502 * Provides the device configuration. 503 * 504 * @syscap SystemCapability.Global.ResourceManager 505 * @crossplatform 506 * @atomicservice 507 * @since 11 508 */ 509 export class Configuration { 510 /** 511 * Indicates the screen direction of the current device. 512 * 513 * @syscap SystemCapability.Global.ResourceManager 514 * @since 6 515 */ 516 /** 517 * Indicates the screen direction of the current device. 518 * 519 * @syscap SystemCapability.Global.ResourceManager 520 * @crossplatform 521 * @since 10 522 */ 523 /** 524 * Indicates the screen direction of the current device. 525 * 526 * @syscap SystemCapability.Global.ResourceManager 527 * @crossplatform 528 * @atomicservice 529 * @since 11 530 */ 531 /** 532 * Indicates the screen direction of the current device. 533 * 534 * @type { Direction } 535 * @syscap SystemCapability.Global.ResourceManager 536 * @crossplatform 537 * @atomicservice 538 * @since 12 539 */ 540 direction: Direction; 541 542 /** 543 * Indicates the current system language, for example, zh-Hans-CN. 544 * 545 * @syscap SystemCapability.Global.ResourceManager 546 * @since 6 547 */ 548 /** 549 * Indicates the current system language, for example, zh-Hans-CN. 550 * 551 * @syscap SystemCapability.Global.ResourceManager 552 * @crossplatform 553 * @since 10 554 */ 555 /** 556 * Indicates the current system language, for example, zh-Hans-CN. 557 * 558 * @syscap SystemCapability.Global.ResourceManager 559 * @crossplatform 560 * @atomicservice 561 * @since 11 562 */ 563 /** 564 * Indicates the current system language, for example, zh-Hans-CN. 565 * 566 * @type { string } 567 * @syscap SystemCapability.Global.ResourceManager 568 * @crossplatform 569 * @atomicservice 570 * @since 12 571 */ 572 locale: string; 573 574 /** 575 * Indicates the device type. 576 * 577 * @type { DeviceType } 578 * @syscap SystemCapability.Global.ResourceManager 579 * @crossplatform 580 * @atomicservice 581 * @since 12 582 */ 583 deviceType: DeviceType; 584 585 /** 586 * Indicates the screen density. 587 * 588 * @type { ScreenDensity } 589 * @syscap SystemCapability.Global.ResourceManager 590 * @crossplatform 591 * @atomicservice 592 * @since 12 593 */ 594 screenDensity: ScreenDensity; 595 596 /** 597 * Indicates the color mode. 598 * 599 * @type { ColorMode } 600 * @syscap SystemCapability.Global.ResourceManager 601 * @crossplatform 602 * @atomicservice 603 * @since 12 604 */ 605 colorMode: ColorMode; 606 607 /** 608 * Indicates the mcc. 609 * 610 * @type { number } 611 * @syscap SystemCapability.Global.ResourceManager 612 * @crossplatform 613 * @atomicservice 614 * @since 12 615 */ 616 mcc: number; 617 618 /** 619 * Indicates the mnc. 620 * 621 * @type { number } 622 * @syscap SystemCapability.Global.ResourceManager 623 * @crossplatform 624 * @atomicservice 625 * @since 12 626 */ 627 mnc: number; 628 } 629 630 /** 631 * Provides the device capability. 632 * 633 * @syscap SystemCapability.Global.ResourceManager 634 * @since 6 635 */ 636 /** 637 * Provides the device capability. 638 * 639 * @syscap SystemCapability.Global.ResourceManager 640 * @crossplatform 641 * @since 10 642 */ 643 /** 644 * Provides the device capability. 645 * 646 * @syscap SystemCapability.Global.ResourceManager 647 * @crossplatform 648 * @atomicservice 649 * @since 11 650 */ 651 export class DeviceCapability { 652 /** 653 * Indicates the screen density of the current device. 654 * 655 * @syscap SystemCapability.Global.ResourceManager 656 * @since 6 657 */ 658 /** 659 * Indicates the screen density of the current device. 660 * 661 * @syscap SystemCapability.Global.ResourceManager 662 * @crossplatform 663 * @since 10 664 */ 665 /** 666 * Indicates the screen density of the current device. 667 * 668 * @syscap SystemCapability.Global.ResourceManager 669 * @crossplatform 670 * @atomicservice 671 * @since 11 672 */ 673 /** 674 * Indicates the screen density of the current device. 675 * 676 * @type { ScreenDensity } 677 * @syscap SystemCapability.Global.ResourceManager 678 * @crossplatform 679 * @atomicservice 680 * @since 12 681 */ 682 screenDensity: ScreenDensity; 683 684 /** 685 * Indicates the type of the current device. 686 * 687 * @syscap SystemCapability.Global.ResourceManager 688 * @since 6 689 */ 690 /** 691 * Indicates the type of the current device. 692 * 693 * @syscap SystemCapability.Global.ResourceManager 694 * @crossplatform 695 * @since 10 696 */ 697 /** 698 * Indicates the type of the current device. 699 * 700 * @syscap SystemCapability.Global.ResourceManager 701 * @crossplatform 702 * @atomicservice 703 * @since 11 704 */ 705 /** 706 * Indicates the type of the current device. 707 * 708 * @type { DeviceType } 709 * @syscap SystemCapability.Global.ResourceManager 710 * @crossplatform 711 * @atomicservice 712 * @since 12 713 */ 714 deviceType: DeviceType; 715 } 716 717 /** 718 * The ResourceManager callback. 719 * 720 * @interface AsyncCallback 721 * @syscap SystemCapability.Global.ResourceManager 722 * @since 6 723 * @deprecated since 9 724 */ 725 export interface AsyncCallback<T> { 726 /** 727 * Defines the callback format. 728 * 729 * @param { Error } err - Indicates the error info. 730 * @param { T } data - Indicates the return data. 731 * @syscap SystemCapability.Global.ResourceManager 732 * @since 6 733 * @deprecated since 9 734 */ 735 (err: Error, data: T): void; 736 } 737 738 /** 739 * Obtains the ResourceManager object of the current application. 740 * 741 * @param { AsyncCallback<ResourceManager> } callback - Indicates the callback containing the ResourceManager object. 742 * @syscap SystemCapability.Global.ResourceManager 743 * @FAModelOnly 744 * @since 6 745 */ 746 /** 747 * Obtains the ResourceManager object of the current application. 748 * 749 * @param { AsyncCallback<ResourceManager> } callback - Indicates the callback containing the ResourceManager object. 750 * @syscap SystemCapability.Global.ResourceManager 751 * @FAModelOnly 752 * @since 11 753 */ 754 export function getResourceManager(callback: AsyncCallback<ResourceManager>): void; 755 756 /** 757 * Obtains the ResourceManager object of the specified application. 758 * 759 * @param { string } bundleName - Indicates the bundle name of the specified application. 760 * @param { AsyncCallback<ResourceManager> } callback - Indicates the callback containing the ResourceManager object. 761 * @syscap SystemCapability.Global.ResourceManager 762 * @FAModelOnly 763 * @since 6 764 */ 765 /** 766 * Obtains the ResourceManager object of the specified application. 767 * 768 * @param { string } bundleName - Indicates the bundle name of the specified application. 769 * @param { AsyncCallback<ResourceManager> } callback - Indicates the callback containing the ResourceManager object. 770 * @syscap SystemCapability.Global.ResourceManager 771 * @FAModelOnly 772 * @since 11 773 */ 774 export function getResourceManager(bundleName: string, callback: AsyncCallback<ResourceManager>): void; 775 776 /** 777 * Obtains the ResourceManager object of the current application. 778 * 779 * @returns { Promise<ResourceManager> } The ResourceManager object is returned in Promise mode. 780 * @syscap SystemCapability.Global.ResourceManager 781 * @FAModelOnly 782 * @since 6 783 */ 784 /** 785 * Obtains the ResourceManager object of the current application. 786 * 787 * @returns { Promise<ResourceManager> } The ResourceManager object is returned in Promise mode. 788 * @syscap SystemCapability.Global.ResourceManager 789 * @FAModelOnly 790 * @since 11 791 */ 792 export function getResourceManager(): Promise<ResourceManager>; 793 794 /** 795 * Obtains the ResourceManager object of the specified application. 796 * 797 * @param { string } bundleName - Indicates the bundle name of the specified application. 798 * @returns { Promise<ResourceManager> } The ResourceManager object is returned in Promise mode. 799 * @syscap SystemCapability.Global.ResourceManager 800 * @FAModelOnly 801 * @since 6 802 */ 803 /** 804 * Obtains the ResourceManager object of the specified application. 805 * 806 * @param { string } bundleName - Indicates the bundle name of the specified application. 807 * @returns { Promise<ResourceManager> } The ResourceManager object is returned in Promise mode. 808 * @syscap SystemCapability.Global.ResourceManager 809 * @FAModelOnly 810 * @since 11 811 */ 812 export function getResourceManager(bundleName: string): Promise<ResourceManager>; 813 814 /** 815 * Obtains a global shared system ResourceManager object that provides access to only system resource, in which the 816 * resConfig is default value(contains resLocale, screenDensityDpi, direction, etc). 817 * 818 * @returns { ResourceManager } The System ResourceManager object is returned. 819 * @throws { BusinessError } 9001009 - Failed to access the system resource. 820 * which is not mapped to application sandbox, This error code will be thrown. 821 * @syscap SystemCapability.Global.ResourceManager 822 * @since 10 823 */ 824 /** 825 * Obtains a global shared system ResourceManager object that provides access to only system resource, in which the 826 * resConfig is default value(contains resLocale, screenDensityDpi, direction, etc). 827 * 828 * @returns { ResourceManager } The System ResourceManager object is returned. 829 * @throws { BusinessError } 9001009 - Failed to access the system resource. 830 * which is not mapped to application sandbox, This error code will be thrown. 831 * @syscap SystemCapability.Global.ResourceManager 832 * @crossplatform 833 * @atomicservice 834 * @since 11 835 */ 836 export function getSystemResourceManager(): ResourceManager; 837 838 /** 839 * Provides the capability of accessing application resources. 840 * 841 * @interface ResourceManager 842 * @syscap SystemCapability.Global.ResourceManager 843 * @since 6 844 */ 845 /** 846 * Provides the capability of accessing application resources. 847 * 848 * @interface ResourceManager 849 * @syscap SystemCapability.Global.ResourceManager 850 * @crossplatform 851 * @since 10 852 */ 853 /** 854 * Provides the capability of accessing application resources. 855 * 856 * @interface ResourceManager 857 * @syscap SystemCapability.Global.ResourceManager 858 * @crossplatform 859 * @atomicservice 860 * @since 11 861 */ 862 export interface ResourceManager { 863 /** 864 * Obtains the character string corresponding to a specified resource ID in callback mode. 865 * 866 * @param { number } resId - Indicates the resource ID. 867 * @param { AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 868 * @syscap SystemCapability.Global.ResourceManager 869 * @since 6 870 * @deprecated since 9 871 * @useinstead ohos.resourceManager.getStringValue 872 */ 873 getString(resId: number, callback: AsyncCallback<string>): void; 874 875 /** 876 * Obtains string resources associated with a specified resource ID in Promise mode. 877 * 878 * @param { number } resId - Indicates the resource ID. 879 * @returns { Promise<string> } The character string corresponding to the resource ID. 880 * @syscap SystemCapability.Global.ResourceManager 881 * @since 6 882 * @deprecated since 9 883 * @useinstead ohos.resourceManager.getStringValue 884 */ 885 getString(resId: number): Promise<string>; 886 887 /** 888 * Obtains the character string corresponding to a specified resource object in callback mode. 889 * 890 * @param { Resource } resource - Indicates the resource object. 891 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 892 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 893 * @throws { BusinessError } 9001001 - Invalid resource ID. 894 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 895 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 896 * @syscap SystemCapability.Global.ResourceManager 897 * @stagemodelonly 898 * @since 9 899 */ 900 /** 901 * Obtains the character string corresponding to a specified resource object in callback mode. 902 * 903 * @param { Resource } resource - Indicates the resource object. 904 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 905 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 906 * @throws { BusinessError } 9001001 - Invalid resource ID. 907 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 908 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 909 * @syscap SystemCapability.Global.ResourceManager 910 * @stagemodelonly 911 * @crossplatform 912 * @since 10 913 */ 914 /** 915 * Obtains the character string corresponding to a specified resource object in callback mode. 916 * 917 * @param { Resource } resource - Indicates the resource object. 918 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 919 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 920 * @throws { BusinessError } 9001001 - Invalid resource ID. 921 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 922 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 923 * @syscap SystemCapability.Global.ResourceManager 924 * @stagemodelonly 925 * @crossplatform 926 * @atomicservice 927 * @since 11 928 */ 929 getStringValue(resource: Resource, callback: _AsyncCallback<string>): void; 930 931 /** 932 * Obtains string resources associated with a specified resource object in Promise mode. 933 * 934 * @param { Resource } resource - Indicates the resource object. 935 * @returns { Promise<string> } The character string corresponding to the resource object. 936 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 937 * @throws { BusinessError } 9001001 - Invalid resource ID. 938 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 939 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 940 * @syscap SystemCapability.Global.ResourceManager 941 * @stagemodelonly 942 * @since 9 943 */ 944 /** 945 * Obtains string resources associated with a specified resource object in Promise mode. 946 * 947 * @param { Resource } resource - Indicates the resource object. 948 * @returns { Promise<string> } The character string corresponding to the resource object. 949 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 950 * @throws { BusinessError } 9001001 - Invalid resource ID. 951 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 952 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 953 * @syscap SystemCapability.Global.ResourceManager 954 * @stagemodelonly 955 * @crossplatform 956 * @since 10 957 */ 958 /** 959 * Obtains string resources associated with a specified resource object in Promise mode. 960 * 961 * @param { Resource } resource - Indicates the resource object. 962 * @returns { Promise<string> } The character string corresponding to the resource object. 963 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 964 * @throws { BusinessError } 9001001 - Invalid resource ID. 965 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 966 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 967 * @syscap SystemCapability.Global.ResourceManager 968 * @stagemodelonly 969 * @crossplatform 970 * @atomicservice 971 * @since 11 972 */ 973 getStringValue(resource: Resource): Promise<string>; 974 975 /** 976 * Obtains the array of character strings corresponding to a specified resource ID in callback mode. 977 * 978 * @param { number } resId - Indicates the resource ID. 979 * @param { AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 980 * @syscap SystemCapability.Global.ResourceManager 981 * @since 6 982 * @deprecated since 9 983 * @useinstead ohos.resourceManager.getStringArrayValue 984 */ 985 getStringArray(resId: number, callback: AsyncCallback<Array<string>>): void; 986 987 /** 988 * Obtains the array of character strings corresponding to a specified resource ID in Promise mode. 989 * 990 * @param { number } resId - Indicates the resource ID. 991 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource ID. 992 * @syscap SystemCapability.Global.ResourceManager 993 * @since 6 994 * @deprecated since 9 995 * @useinstead ohos.resourceManager.getStringArrayValue 996 */ 997 getStringArray(resId: number): Promise<Array<string>>; 998 999 /** 1000 * Obtains the array of character strings corresponding to a specified resource object in callback mode. 1001 * 1002 * @param { Resource } resource - Indicates the resource object. 1003 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 1004 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1005 * @throws { BusinessError } 9001001 - Invalid resource ID. 1006 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1007 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1008 * @syscap SystemCapability.Global.ResourceManager 1009 * @stagemodelonly 1010 * @since 9 1011 */ 1012 /** 1013 * Obtains the array of character strings corresponding to a specified resource object in callback mode. 1014 * 1015 * @param { Resource } resource - Indicates the resource object. 1016 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 1017 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1018 * @throws { BusinessError } 9001001 - Invalid resource ID. 1019 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1020 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1021 * @syscap SystemCapability.Global.ResourceManager 1022 * @stagemodelonly 1023 * @crossplatform 1024 * @since 10 1025 */ 1026 /** 1027 * Obtains the array of character strings corresponding to a specified resource object in callback mode. 1028 * 1029 * @param { Resource } resource - Indicates the resource object. 1030 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 1031 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1032 * @throws { BusinessError } 9001001 - Invalid resource ID. 1033 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1034 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1035 * @syscap SystemCapability.Global.ResourceManager 1036 * @stagemodelonly 1037 * @crossplatform 1038 * @atomicservice 1039 * @since 11 1040 */ 1041 getStringArrayValue(resource: Resource, callback: _AsyncCallback<Array<string>>): void; 1042 1043 /** 1044 * Obtains the array of character strings corresponding to a specified resource object in Promise mode. 1045 * 1046 * @param { Resource } resource - Indicates the resource object. 1047 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource object. 1048 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1049 * @throws { BusinessError } 9001001 - Invalid resource ID. 1050 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1051 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1052 * @syscap SystemCapability.Global.ResourceManager 1053 * @stagemodelonly 1054 * @since 9 1055 */ 1056 /** 1057 * Obtains the array of character strings corresponding to a specified resource object in Promise mode. 1058 * 1059 * @param { Resource } resource - Indicates the resource object. 1060 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource object. 1061 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1062 * @throws { BusinessError } 9001001 - Invalid resource ID. 1063 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1064 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1065 * @syscap SystemCapability.Global.ResourceManager 1066 * @stagemodelonly 1067 * @crossplatform 1068 * @since 10 1069 */ 1070 /** 1071 * Obtains the array of character strings corresponding to a specified resource object in Promise mode. 1072 * 1073 * @param { Resource } resource - Indicates the resource object. 1074 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource object. 1075 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1076 * @throws { BusinessError } 9001001 - Invalid resource ID. 1077 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1078 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1079 * @syscap SystemCapability.Global.ResourceManager 1080 * @stagemodelonly 1081 * @crossplatform 1082 * @atomicservice 1083 * @since 11 1084 */ 1085 getStringArrayValue(resource: Resource): Promise<Array<string>>; 1086 1087 /** 1088 * Obtains the content of the media file corresponding to a specified resource ID in callback mode. 1089 * 1090 * @param { number } resId - Indicates the resource ID. 1091 * @param { AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1092 * @syscap SystemCapability.Global.ResourceManager 1093 * @since 6 1094 * @deprecated since 9 1095 * @useinstead ohos.resourceManager.getMediaContent 1096 */ 1097 getMedia(resId: number, callback: AsyncCallback<Uint8Array>): void; 1098 1099 /** 1100 * Obtains the content of the media file corresponding to a specified resource ID in Promise mode. 1101 * 1102 * @param { number } resId - Indicates the resource ID. 1103 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource ID. 1104 * @syscap SystemCapability.Global.ResourceManager 1105 * @since 6 1106 * @deprecated since 9 1107 * @useinstead ohos.resourceManager.getMediaContent 1108 */ 1109 getMedia(resId: number): Promise<Uint8Array>; 1110 1111 /** 1112 * Obtains the content of the media file corresponding to a specified resource object in callback mode. 1113 * 1114 * @param { Resource } resource - Indicates the resource object. 1115 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1116 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1117 * @throws { BusinessError } 9001001 - Invalid resource ID. 1118 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1119 * @syscap SystemCapability.Global.ResourceManager 1120 * @stagemodelonly 1121 * @since 9 1122 */ 1123 /** 1124 * Obtains the content of the media file corresponding to a specified resource object in callback mode. 1125 * 1126 * @param { Resource } resource - Indicates the resource object. 1127 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1128 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1129 * @throws { BusinessError } 9001001 - Invalid resource ID. 1130 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1131 * @syscap SystemCapability.Global.ResourceManager 1132 * @stagemodelonly 1133 * @crossplatform 1134 * @since 10 1135 */ 1136 /** 1137 * Obtains the content of the media file corresponding to a specified resource object in callback mode. 1138 * 1139 * @param { Resource } resource - Indicates the resource object. 1140 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1141 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1142 * @throws { BusinessError } 9001001 - Invalid resource ID. 1143 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1144 * @syscap SystemCapability.Global.ResourceManager 1145 * @stagemodelonly 1146 * @crossplatform 1147 * @atomicservice 1148 * @since 11 1149 */ 1150 getMediaContent(resource: Resource, callback: _AsyncCallback<Uint8Array>): void; 1151 1152 /** 1153 * Obtains the content of the specified screen density media file corresponding to a specified resource object in callback mode. 1154 * 1155 * @param { Resource } resource - Indicates the resource object. 1156 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1157 * to use the density of current system dpi. 1158 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained 1159 * specified screen density media file content. 1160 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1161 * @throws { BusinessError } 9001001 - Invalid resource ID. 1162 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1163 * @syscap SystemCapability.Global.ResourceManager 1164 * @stagemodelonly 1165 * @since 10 1166 */ 1167 /** 1168 * Obtains the content of the specified screen density media file corresponding to a specified resource object in callback mode. 1169 * 1170 * @param { Resource } resource - Indicates the resource object. 1171 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1172 * to use the density of current system dpi. 1173 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained 1174 * specified screen density media file content. 1175 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1176 * @throws { BusinessError } 9001001 - Invalid resource ID. 1177 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1178 * @syscap SystemCapability.Global.ResourceManager 1179 * @stagemodelonly 1180 * @crossplatform 1181 * @atomicservice 1182 * @since 11 1183 */ 1184 getMediaContent(resource: Resource, density: number, callback: _AsyncCallback<Uint8Array>): void; 1185 1186 /** 1187 * Obtains the content of the media file corresponding to a specified resource object in Promise mode. 1188 * 1189 * @param { Resource } resource - Indicates the resource object. 1190 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource object. 1191 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1192 * @throws { BusinessError } 9001001 - Invalid resource ID. 1193 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1194 * @syscap SystemCapability.Global.ResourceManager 1195 * @stagemodelonly 1196 * @since 9 1197 */ 1198 /** 1199 * Obtains the content of the media file corresponding to a specified resource object in Promise mode. 1200 * 1201 * @param { Resource } resource - Indicates the resource object. 1202 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource object. 1203 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1204 * @throws { BusinessError } 9001001 - Invalid resource ID. 1205 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1206 * @syscap SystemCapability.Global.ResourceManager 1207 * @stagemodelonly 1208 * @crossplatform 1209 * @since 10 1210 */ 1211 /** 1212 * Obtains the content of the media file corresponding to a specified resource object in Promise mode. 1213 * 1214 * @param { Resource } resource - Indicates the resource object. 1215 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource object. 1216 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1217 * @throws { BusinessError } 9001001 - Invalid resource ID. 1218 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1219 * @syscap SystemCapability.Global.ResourceManager 1220 * @stagemodelonly 1221 * @crossplatform 1222 * @atomicservice 1223 * @since 11 1224 */ 1225 getMediaContent(resource: Resource): Promise<Uint8Array>; 1226 1227 /** 1228 * Obtains the content of the specified screen density media file corresponding to a specified resource object in Promise mode. 1229 * 1230 * @param { Resource } resource - Indicates the resource object. 1231 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1232 * to use the density of current system dpi. 1233 * @returns { Promise<Uint8Array> } The content of the specified screen density media file corresponding to the 1234 * specified resource object. 1235 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1236 * @throws { BusinessError } 9001001 - Invalid resource ID. 1237 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1238 * @syscap SystemCapability.Global.ResourceManager 1239 * @stagemodelonly 1240 * @since 10 1241 */ 1242 /** 1243 * Obtains the content of the specified screen density media file corresponding to a specified resource object in Promise mode. 1244 * 1245 * @param { Resource } resource - Indicates the resource object. 1246 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1247 * to use the density of current system dpi. 1248 * @returns { Promise<Uint8Array> } The content of the specified screen density media file corresponding to the 1249 * specified resource object. 1250 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1251 * @throws { BusinessError } 9001001 - Invalid resource ID. 1252 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1253 * @syscap SystemCapability.Global.ResourceManager 1254 * @stagemodelonly 1255 * @crossplatform 1256 * @atomicservice 1257 * @since 11 1258 */ 1259 getMediaContent(resource: Resource, density: number): Promise<Uint8Array>; 1260 1261 /** 1262 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in callback mode. 1263 * 1264 * @param { number } resId - Indicates the resource ID. 1265 * @param { AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 1266 * resource. 1267 * @syscap SystemCapability.Global.ResourceManager 1268 * @since 6 1269 * @deprecated since 9 1270 * @useinstead ohos.resourceManager.getMediaContentBase64 1271 */ 1272 getMediaBase64(resId: number, callback: AsyncCallback<string>): void; 1273 1274 /** 1275 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode. 1276 * 1277 * @param { number } resId - Indicates the resource ID. 1278 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource ID. 1279 * @syscap SystemCapability.Global.ResourceManager 1280 * @since 6 1281 * @deprecated since 9 1282 * @useinstead ohos.resourceManager.getMediaContentBase64 1283 */ 1284 getMediaBase64(resId: number): Promise<string>; 1285 1286 /** 1287 * Obtains the Base64 code of the image resource corresponding to the specified resource object in callback mode. 1288 * 1289 * @param { Resource } resource - Indicates the resource object. 1290 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 1291 * resource. 1292 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1293 * @throws { BusinessError } 9001001 - Invalid resource ID. 1294 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1295 * @syscap SystemCapability.Global.ResourceManager 1296 * @stagemodelonly 1297 * @since 9 1298 */ 1299 /** 1300 * Obtains the Base64 code of the image resource corresponding to the specified resource object in callback mode. 1301 * 1302 * @param { Resource } resource - Indicates the resource object. 1303 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 1304 * resource. 1305 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1306 * @throws { BusinessError } 9001001 - Invalid resource ID. 1307 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1308 * @syscap SystemCapability.Global.ResourceManager 1309 * @stagemodelonly 1310 * @crossplatform 1311 * @since 10 1312 */ 1313 /** 1314 * Obtains the Base64 code of the image resource corresponding to the specified resource object in callback mode. 1315 * 1316 * @param { Resource } resource - Indicates the resource object. 1317 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 1318 * resource. 1319 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1320 * @throws { BusinessError } 9001001 - Invalid resource ID. 1321 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1322 * @syscap SystemCapability.Global.ResourceManager 1323 * @stagemodelonly 1324 * @crossplatform 1325 * @atomicservice 1326 * @since 11 1327 */ 1328 getMediaContentBase64(resource: Resource, callback: _AsyncCallback<string>): void; 1329 1330 /** 1331 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource object in callback mode. 1332 * 1333 * @param { Resource } resource - Indicates the resource object. 1334 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1335 * to use the density of current system dpi. 1336 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the 1337 * specified screen density image resource. 1338 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1339 * @throws { BusinessError } 9001001 - Invalid resource ID. 1340 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1341 * @syscap SystemCapability.Global.ResourceManager 1342 * @stagemodelonly 1343 * @since 10 1344 */ 1345 /** 1346 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource object in callback mode. 1347 * 1348 * @param { Resource } resource - Indicates the resource object. 1349 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1350 * to use the density of current system dpi. 1351 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the 1352 * specified screen density image resource. 1353 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1354 * @throws { BusinessError } 9001001 - Invalid resource ID. 1355 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1356 * @syscap SystemCapability.Global.ResourceManager 1357 * @stagemodelonly 1358 * @crossplatform 1359 * @atomicservice 1360 * @since 11 1361 */ 1362 getMediaContentBase64(resource: Resource, density: number, callback: _AsyncCallback<string>): void; 1363 1364 /** 1365 * Obtains the Base64 code of the image resource corresponding to the specified resource object in Promise mode. 1366 * 1367 * @param { Resource } resource - Indicates the resource object. 1368 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource object. 1369 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1370 * @throws { BusinessError } 9001001 - Invalid resource ID. 1371 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1372 * @syscap SystemCapability.Global.ResourceManager 1373 * @stagemodelonly 1374 * @since 9 1375 */ 1376 /** 1377 * Obtains the Base64 code of the image resource corresponding to the specified resource object in Promise mode. 1378 * 1379 * @param { Resource } resource - Indicates the resource object. 1380 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource object. 1381 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1382 * @throws { BusinessError } 9001001 - Invalid resource ID. 1383 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1384 * @syscap SystemCapability.Global.ResourceManager 1385 * @stagemodelonly 1386 * @crossplatform 1387 * @since 10 1388 */ 1389 /** 1390 * Obtains the Base64 code of the image resource corresponding to the specified resource object in Promise mode. 1391 * 1392 * @param { Resource } resource - Indicates the resource object. 1393 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource object. 1394 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1395 * @throws { BusinessError } 9001001 - Invalid resource ID. 1396 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1397 * @syscap SystemCapability.Global.ResourceManager 1398 * @stagemodelonly 1399 * @crossplatform 1400 * @atomicservice 1401 * @since 11 1402 */ 1403 getMediaContentBase64(resource: Resource): Promise<string>; 1404 1405 /** 1406 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource object in Promise mode. 1407 * 1408 * @param { Resource } resource - Indicates the resource object. 1409 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1410 * to use the density of current system dpi. 1411 * @returns { Promise<string> } The Base64 code of the specified screen density image resource corresponding to the specified resource object. 1412 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1413 * @throws { BusinessError } 9001001 - Invalid resource ID. 1414 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1415 * @syscap SystemCapability.Global.ResourceManager 1416 * @stagemodelonly 1417 * @since 10 1418 */ 1419 /** 1420 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource object in Promise mode. 1421 * 1422 * @param { Resource } resource - Indicates the resource object. 1423 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1424 * to use the density of current system dpi. 1425 * @returns { Promise<string> } The Base64 code of the specified screen density image resource corresponding to the specified resource object. 1426 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1427 * @throws { BusinessError } 9001001 - Invalid resource ID. 1428 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1429 * @syscap SystemCapability.Global.ResourceManager 1430 * @stagemodelonly 1431 * @crossplatform 1432 * @atomicservice 1433 * @since 11 1434 */ 1435 getMediaContentBase64(resource: Resource, density: number): Promise<string>; 1436 1437 /** 1438 * Obtains the device capability in callback mode. 1439 * 1440 * @param { _AsyncCallback<DeviceCapability> } callback - Indicates the asynchronous callback used to return the obtained device capability. 1441 * @syscap SystemCapability.Global.ResourceManager 1442 * @since 6 1443 */ 1444 /** 1445 * Obtains the device capability in callback mode. 1446 * 1447 * @param { _AsyncCallback<DeviceCapability> } callback - Indicates the asynchronous callback used to return the obtained device capability. 1448 * @syscap SystemCapability.Global.ResourceManager 1449 * @crossplatform 1450 * @since 10 1451 */ 1452 /** 1453 * Obtains the device capability in callback mode. 1454 * 1455 * @param { _AsyncCallback<DeviceCapability> } callback - Indicates the asynchronous callback used to return the obtained device capability. 1456 * @syscap SystemCapability.Global.ResourceManager 1457 * @crossplatform 1458 * @atomicservice 1459 * @since 11 1460 */ 1461 getDeviceCapability(callback: _AsyncCallback<DeviceCapability>): void; 1462 1463 /** 1464 * Obtains the device capability in Promise mode. 1465 * 1466 * @returns { Promise<DeviceCapability> } the device capability. 1467 * @syscap SystemCapability.Global.ResourceManager 1468 * @since 6 1469 */ 1470 /** 1471 * Obtains the device capability in Promise mode. 1472 * 1473 * @returns { Promise<DeviceCapability> } the device capability. 1474 * @syscap SystemCapability.Global.ResourceManager 1475 * @crossplatform 1476 * @since 10 1477 */ 1478 /** 1479 * Obtains the device capability in Promise mode. 1480 * 1481 * @returns { Promise<DeviceCapability> } the device capability. 1482 * @syscap SystemCapability.Global.ResourceManager 1483 * @crossplatform 1484 * @atomicservice 1485 * @since 11 1486 */ 1487 getDeviceCapability(): Promise<DeviceCapability>; 1488 1489 /** 1490 * Obtains the device configuration in callback mode. 1491 * 1492 * @param { _AsyncCallback<Configuration> } callback - Indicates the asynchronous callback used to return the obtained device 1493 * configuration. 1494 * @syscap SystemCapability.Global.ResourceManager 1495 * @since 6 1496 */ 1497 /** 1498 * Obtains the device configuration in callback mode. 1499 * 1500 * @param { _AsyncCallback<Configuration> } callback - Indicates the asynchronous callback used to return the obtained device 1501 * configuration. 1502 * @syscap SystemCapability.Global.ResourceManager 1503 * @crossplatform 1504 * @since 10 1505 */ 1506 /** 1507 * Obtains the device configuration in callback mode. 1508 * 1509 * @param { _AsyncCallback<Configuration> } callback - Indicates the asynchronous callback used to return the obtained device 1510 * configuration. 1511 * @syscap SystemCapability.Global.ResourceManager 1512 * @crossplatform 1513 * @atomicservice 1514 * @since 11 1515 */ 1516 getConfiguration(callback: _AsyncCallback<Configuration>): void; 1517 1518 /** 1519 * Obtains the device configuration in Promise mode. 1520 * 1521 * @returns { Promise<Configuration> } the device configuration. 1522 * @syscap SystemCapability.Global.ResourceManager 1523 * @since 6 1524 */ 1525 /** 1526 * Obtains the device configuration in Promise mode. 1527 * 1528 * @returns { Promise<Configuration> } the device configuration. 1529 * @syscap SystemCapability.Global.ResourceManager 1530 * @crossplatform 1531 * @since 10 1532 */ 1533 /** 1534 * Obtains the device configuration in Promise mode. 1535 * 1536 * @returns { Promise<Configuration> } the device configuration. 1537 * @syscap SystemCapability.Global.ResourceManager 1538 * @crossplatform 1539 * @atomicservice 1540 * @since 11 1541 */ 1542 getConfiguration(): Promise<Configuration>; 1543 1544 /** 1545 * Obtains the singular-plural character string represented by the ID string corresponding to the 1546 * specified number in callback mode. 1547 * 1548 * @param { number } resId - Indicates the resource ID. 1549 * @param { number } num - Indicates the number. 1550 * @param { AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 1551 * string represented by the ID string corresponding to the specified number. 1552 * @syscap SystemCapability.Global.ResourceManager 1553 * @since 6 1554 * @deprecated since 9 1555 * @useinstead ohos.resourceManager.getPluralStringValue 1556 */ 1557 getPluralString(resId: number, num: number, callback: AsyncCallback<string>): void; 1558 1559 /** 1560 * Obtains the singular-plural character string represented by the ID string corresponding to 1561 * the specified number in Promise mode. 1562 * 1563 * @param { number } resId - Indicates the resource ID. 1564 * @param { number } num - Indicates the number. 1565 * @returns { Promise<string> } The singular-plural character string represented by the ID string 1566 * corresponding to the specified number. 1567 * @syscap SystemCapability.Global.ResourceManager 1568 * @since 6 1569 * @deprecated since 9 1570 * @useinstead ohos.resourceManager.getPluralStringValue 1571 */ 1572 getPluralString(resId: number, num: number): Promise<string>; 1573 1574 /** 1575 * Obtains the singular-plural character string represented by the resource object string corresponding to the 1576 * specified number in callback mode. 1577 * 1578 * @param { Resource } resource - Indicates the resource object. 1579 * @param { number } num - Indicates the number. 1580 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 1581 * string represented by the resource object string corresponding to the specified number. 1582 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1583 * @throws { BusinessError } 9001001 - Invalid resource ID. 1584 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1585 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1586 * @syscap SystemCapability.Global.ResourceManager 1587 * @stagemodelonly 1588 * @since 9 1589 */ 1590 /** 1591 * Obtains the singular-plural character string represented by the resource object string corresponding to the 1592 * specified number in callback mode. 1593 * 1594 * @param { Resource } resource - Indicates the resource object. 1595 * @param { number } num - Indicates the number. 1596 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 1597 * string represented by the resource object string corresponding to the specified number. 1598 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1599 * @throws { BusinessError } 9001001 - Invalid resource ID. 1600 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1601 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1602 * @syscap SystemCapability.Global.ResourceManager 1603 * @stagemodelonly 1604 * @crossplatform 1605 * @since 10 1606 */ 1607 /** 1608 * Obtains the singular-plural character string represented by the resource object string corresponding to the 1609 * specified number in callback mode. 1610 * 1611 * @param { Resource } resource - Indicates the resource object. 1612 * @param { number } num - Indicates the number. 1613 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 1614 * string represented by the resource object string corresponding to the specified number. 1615 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1616 * @throws { BusinessError } 9001001 - Invalid resource ID. 1617 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1618 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1619 * @syscap SystemCapability.Global.ResourceManager 1620 * @stagemodelonly 1621 * @crossplatform 1622 * @atomicservice 1623 * @since 11 1624 */ 1625 getPluralStringValue(resource: Resource, num: number, callback: _AsyncCallback<string>): void; 1626 1627 /** 1628 * Obtains the singular-plural character string represented by the resource object string corresponding to 1629 * the specified number in Promise mode. 1630 * 1631 * @param { Resource } resource - Indicates the resource object. 1632 * @param { number } num - Indicates the number. 1633 * @returns { Promise<string> } The singular-plural character string represented by the resource object string 1634 * corresponding to the specified number. 1635 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1636 * @throws { BusinessError } 9001001 - Invalid resource ID. 1637 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1638 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1639 * @syscap SystemCapability.Global.ResourceManager 1640 * @stagemodelonly 1641 * @since 9 1642 */ 1643 /** 1644 * Obtains the singular-plural character string represented by the resource object string corresponding to 1645 * the specified number in Promise mode. 1646 * 1647 * @param { Resource } resource - Indicates the resource object. 1648 * @param { number } num - Indicates the number. 1649 * @returns { Promise<string> } The singular-plural character string represented by the resource object string 1650 * corresponding to the specified number. 1651 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1652 * @throws { BusinessError } 9001001 - Invalid resource ID. 1653 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1654 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1655 * @syscap SystemCapability.Global.ResourceManager 1656 * @stagemodelonly 1657 * @crossplatform 1658 * @since 10 1659 */ 1660 /** 1661 * Obtains the singular-plural character string represented by the resource object string corresponding to 1662 * the specified number in Promise mode. 1663 * 1664 * @param { Resource } resource - Indicates the resource object. 1665 * @param { number } num - Indicates the number. 1666 * @returns { Promise<string> } The singular-plural character string represented by the resource object string 1667 * corresponding to the specified number. 1668 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1669 * @throws { BusinessError } 9001001 - Invalid resource ID. 1670 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 1671 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1672 * @syscap SystemCapability.Global.ResourceManager 1673 * @stagemodelonly 1674 * @crossplatform 1675 * @atomicservice 1676 * @since 11 1677 */ 1678 getPluralStringValue(resource: Resource, num: number): Promise<string>; 1679 1680 /** 1681 * Obtains the raw file resource corresponding to the specified resource path in callback mode. 1682 * 1683 * @param { string } path - Indicates the resource relative path. 1684 * @param { AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the raw file resource. 1685 * @syscap SystemCapability.Global.ResourceManager 1686 * @since 8 1687 * @deprecated since 9 1688 * @useinstead ohos.resourceManager.getRawFileContent 1689 */ 1690 getRawFile(path: string, callback: AsyncCallback<Uint8Array>): void; 1691 1692 /** 1693 * Obtains the raw file resource corresponding to the specified resource path in Promise mode. 1694 * 1695 * @param { string } path - Indicates the resource relative path. 1696 * @returns { Promise<Uint8Array> } The raw file resource corresponding to the specified resource path. 1697 * @syscap SystemCapability.Global.ResourceManager 1698 * @since 8 1699 * @deprecated since 9 1700 * @useinstead ohos.resourceManager.getRawFileContent 1701 */ 1702 getRawFile(path: string): Promise<Uint8Array>; 1703 1704 /** 1705 * Obtains the raw file resource descriptor corresponding to the specified resource path in callback mode. 1706 * 1707 * @param { string } path - Indicates the resource relative path. 1708 * @param { AsyncCallback<RawFileDescriptor> } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. 1709 * @syscap SystemCapability.Global.ResourceManager 1710 * @since 8 1711 * @deprecated since 9 1712 * @useinstead ohos.resourceManager.getRawFd 1713 */ 1714 getRawFileDescriptor(path: string, callback: AsyncCallback<RawFileDescriptor>): void; 1715 1716 /** 1717 * Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode. 1718 * 1719 * @param { string } path - Indicates the resource relative path. 1720 * @returns { Promise<RawFileDescriptor> } The raw file resource descriptor corresponding to the specified resource path. 1721 * @syscap SystemCapability.Global.ResourceManager 1722 * @since 8 1723 * @deprecated since 9 1724 * @useinstead ohos.resourceManager.getRawFd 1725 */ 1726 getRawFileDescriptor(path: string): Promise<RawFileDescriptor>; 1727 1728 /** 1729 * Obtains close raw file resource descriptor corresponding to the specified resource path in callback mode. 1730 * 1731 * @param { string } path - Indicates the resource relative path. 1732 * @param { AsyncCallback<void> } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. 1733 * @syscap SystemCapability.Global.ResourceManager 1734 * @since 8 1735 * @deprecated since 9 1736 * @useinstead ohos.resourceManager.closeRawFd 1737 */ 1738 closeRawFileDescriptor(path: string, callback: AsyncCallback<void>): void; 1739 1740 /** 1741 * Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode. 1742 * 1743 * @param { string } path - Indicates the resource relative path. 1744 * @returns { Promise<void> } The result close raw file resource descriptor corresponding to the specified resource path. 1745 * @syscap SystemCapability.Global.ResourceManager 1746 * @since 8 1747 * @deprecated since 9 1748 * @useinstead ohos.resourceManager.closeRawFd 1749 */ 1750 closeRawFileDescriptor(path: string): Promise<void>; 1751 1752 /** 1753 * Obtains the character string corresponding to a specified resource name in callback mode. 1754 * 1755 * @param { string } resName - Indicates the resource name. 1756 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 1757 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1758 * @throws { BusinessError } 9001003 - Invalid resource name. 1759 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1760 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1761 * @syscap SystemCapability.Global.ResourceManager 1762 * @since 9 1763 */ 1764 /** 1765 * Obtains the character string corresponding to a specified resource name in callback mode. 1766 * 1767 * @param { string } resName - Indicates the resource name. 1768 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 1769 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1770 * @throws { BusinessError } 9001003 - Invalid resource name. 1771 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1772 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1773 * @syscap SystemCapability.Global.ResourceManager 1774 * @crossplatform 1775 * @since 10 1776 */ 1777 /** 1778 * Obtains the character string corresponding to a specified resource name in callback mode. 1779 * 1780 * @param { string } resName - Indicates the resource name. 1781 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 1782 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1783 * @throws { BusinessError } 9001003 - Invalid resource name. 1784 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1785 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1786 * @syscap SystemCapability.Global.ResourceManager 1787 * @crossplatform 1788 * @atomicservice 1789 * @since 11 1790 */ 1791 getStringByName(resName: string, callback: _AsyncCallback<string>): void; 1792 1793 /** 1794 * Obtains string resources associated with a specified resource name in Promise mode. 1795 * 1796 * @param { string } resName - Indicates the resource name. 1797 * @returns { Promise<string> } The character string corresponding to the resource name. 1798 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1799 * @throws { BusinessError } 9001003 - Invalid resource name. 1800 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1801 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1802 * @syscap SystemCapability.Global.ResourceManager 1803 * @since 9 1804 */ 1805 /** 1806 * Obtains string resources associated with a specified resource name in Promise mode. 1807 * 1808 * @param { string } resName - Indicates the resource name. 1809 * @returns { Promise<string> } The character string corresponding to the resource name. 1810 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1811 * @throws { BusinessError } 9001003 - Invalid resource name. 1812 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1813 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1814 * @syscap SystemCapability.Global.ResourceManager 1815 * @crossplatform 1816 * @since 10 1817 */ 1818 /** 1819 * Obtains string resources associated with a specified resource name in Promise mode. 1820 * 1821 * @param { string } resName - Indicates the resource name. 1822 * @returns { Promise<string> } The character string corresponding to the resource name. 1823 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1824 * @throws { BusinessError } 9001003 - Invalid resource name. 1825 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1826 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1827 * @syscap SystemCapability.Global.ResourceManager 1828 * @crossplatform 1829 * @atomicservice 1830 * @since 11 1831 */ 1832 getStringByName(resName: string): Promise<string>; 1833 1834 /** 1835 * Obtains the array of character strings corresponding to a specified resource name in callback mode. 1836 * 1837 * @param { string } resName - Indicates the resource name. 1838 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 1839 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1840 * @throws { BusinessError } 9001003 - Invalid resource name. 1841 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1842 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1843 * @syscap SystemCapability.Global.ResourceManager 1844 * @since 9 1845 */ 1846 /** 1847 * Obtains the array of character strings corresponding to a specified resource name in callback mode. 1848 * 1849 * @param { string } resName - Indicates the resource name. 1850 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 1851 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1852 * @throws { BusinessError } 9001003 - Invalid resource name. 1853 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1854 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1855 * @syscap SystemCapability.Global.ResourceManager 1856 * @crossplatform 1857 * @since 10 1858 */ 1859 /** 1860 * Obtains the array of character strings corresponding to a specified resource name in callback mode. 1861 * 1862 * @param { string } resName - Indicates the resource name. 1863 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 1864 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1865 * @throws { BusinessError } 9001003 - Invalid resource name. 1866 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1867 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1868 * @syscap SystemCapability.Global.ResourceManager 1869 * @crossplatform 1870 * @atomicservice 1871 * @since 11 1872 */ 1873 getStringArrayByName(resName: string, callback: _AsyncCallback<Array<string>>): void; 1874 1875 /** 1876 * Obtains the array of character strings corresponding to a specified resource name in Promise mode. 1877 * 1878 * @param { string } resName - Indicates the resource name. 1879 * @returns { Promise<Array<string>> } the array of character strings corresponding to the specified resource name. 1880 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1881 * @throws { BusinessError } 9001003 - Invalid resource name. 1882 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1883 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1884 * @syscap SystemCapability.Global.ResourceManager 1885 * @since 9 1886 */ 1887 /** 1888 * Obtains the array of character strings corresponding to a specified resource name in Promise mode. 1889 * 1890 * @param { string } resName - Indicates the resource name. 1891 * @returns { Promise<Array<string>> } the array of character strings corresponding to the specified resource name. 1892 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1893 * @throws { BusinessError } 9001003 - Invalid resource name. 1894 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1895 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1896 * @syscap SystemCapability.Global.ResourceManager 1897 * @crossplatform 1898 * @since 10 1899 */ 1900 /** 1901 * Obtains the array of character strings corresponding to a specified resource name in Promise mode. 1902 * 1903 * @param { string } resName - Indicates the resource name. 1904 * @returns { Promise<Array<string>> } the array of character strings corresponding to the specified resource name. 1905 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1906 * @throws { BusinessError } 9001003 - Invalid resource name. 1907 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1908 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 1909 * @syscap SystemCapability.Global.ResourceManager 1910 * @crossplatform 1911 * @atomicservice 1912 * @since 11 1913 */ 1914 getStringArrayByName(resName: string): Promise<Array<string>>; 1915 1916 /** 1917 * Obtains the content of the media file corresponding to a specified resource name in callback mode. 1918 * 1919 * @param { string } resName - Indicates the resource name. 1920 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1921 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1922 * @throws { BusinessError } 9001003 - Invalid resource name. 1923 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1924 * @syscap SystemCapability.Global.ResourceManager 1925 * @since 9 1926 */ 1927 /** 1928 * Obtains the content of the media file corresponding to a specified resource name in callback mode. 1929 * 1930 * @param { string } resName - Indicates the resource name. 1931 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1932 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1933 * @throws { BusinessError } 9001003 - Invalid resource name. 1934 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1935 * @syscap SystemCapability.Global.ResourceManager 1936 * @crossplatform 1937 * @since 10 1938 */ 1939 /** 1940 * Obtains the content of the media file corresponding to a specified resource name in callback mode. 1941 * 1942 * @param { string } resName - Indicates the resource name. 1943 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 1944 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1945 * @throws { BusinessError } 9001003 - Invalid resource name. 1946 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1947 * @syscap SystemCapability.Global.ResourceManager 1948 * @crossplatform 1949 * @atomicservice 1950 * @since 11 1951 */ 1952 getMediaByName(resName: string, callback: _AsyncCallback<Uint8Array>): void; 1953 1954 /** 1955 * Obtains the content of the specified screen density media file corresponding to a specified resource name in callback mode. 1956 * 1957 * @param { string } resName - Indicates the resource name. 1958 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1959 * to use the density of current system dpi. 1960 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained 1961 * specified screen density media file content. 1962 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1963 * @throws { BusinessError } 9001003 - Invalid resource name. 1964 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1965 * @syscap SystemCapability.Global.ResourceManager 1966 * @since 10 1967 */ 1968 /** 1969 * Obtains the content of the specified screen density media file corresponding to a specified resource name in callback mode. 1970 * 1971 * @param { string } resName - Indicates the resource name. 1972 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 1973 * to use the density of current system dpi. 1974 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained 1975 * specified screen density media file content. 1976 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 1977 * @throws { BusinessError } 9001003 - Invalid resource name. 1978 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1979 * @syscap SystemCapability.Global.ResourceManager 1980 * @crossplatform 1981 * @atomicservice 1982 * @since 11 1983 */ 1984 getMediaByName(resName: string, density: number, callback: _AsyncCallback<Uint8Array>): void; 1985 1986 /** 1987 * Obtains the content of the media file corresponding to a specified resource name in Promise mode. 1988 * 1989 * @param { string } resName - Indicates the resource name. 1990 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource name. 1991 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 1992 * @throws { BusinessError } 9001003 - Invalid resource name. 1993 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 1994 * @syscap SystemCapability.Global.ResourceManager 1995 * @since 9 1996 */ 1997 /** 1998 * Obtains the content of the media file corresponding to a specified resource name in Promise mode. 1999 * 2000 * @param { string } resName - Indicates the resource name. 2001 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource name. 2002 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2003 * @throws { BusinessError } 9001003 - Invalid resource name. 2004 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2005 * @syscap SystemCapability.Global.ResourceManager 2006 * @crossplatform 2007 * @since 10 2008 */ 2009 /** 2010 * Obtains the content of the media file corresponding to a specified resource name in Promise mode. 2011 * 2012 * @param { string } resName - Indicates the resource name. 2013 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource name. 2014 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2015 * @throws { BusinessError } 9001003 - Invalid resource name. 2016 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2017 * @syscap SystemCapability.Global.ResourceManager 2018 * @crossplatform 2019 * @atomicservice 2020 * @since 11 2021 */ 2022 getMediaByName(resName: string): Promise<Uint8Array>; 2023 2024 /** 2025 * Obtains the content of the specified screen density media file corresponding to a specified resource name in Promise mode. 2026 * 2027 * @param { string } resName - Indicates the resource name. 2028 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 2029 * to use the density of current system dpi. 2030 * @returns { Promise<Uint8Array> } The content of the specified screen density media file corresponding to the 2031 * specified resource name. 2032 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 2033 * @throws { BusinessError } 9001003 - Invalid resource name. 2034 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2035 * @syscap SystemCapability.Global.ResourceManager 2036 * @since 10 2037 */ 2038 /** 2039 * Obtains the content of the specified screen density media file corresponding to a specified resource name in Promise mode. 2040 * 2041 * @param { string } resName - Indicates the resource name. 2042 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 2043 * to use the density of current system dpi. 2044 * @returns { Promise<Uint8Array> } The content of the specified screen density media file corresponding to the 2045 * specified resource name. 2046 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 2047 * @throws { BusinessError } 9001003 - Invalid resource name. 2048 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2049 * @syscap SystemCapability.Global.ResourceManager 2050 * @crossplatform 2051 * @atomicservice 2052 * @since 11 2053 */ 2054 getMediaByName(resName: string, density: number): Promise<Uint8Array>; 2055 2056 /** 2057 * Obtains the Base64 code of the image resource corresponding to the specified resource name in callback mode. 2058 * 2059 * @param { string } resName - Indicates the resource name. 2060 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 2061 * resource. 2062 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2063 * @throws { BusinessError } 9001003 - Invalid resource name. 2064 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2065 * @syscap SystemCapability.Global.ResourceManager 2066 * @since 9 2067 */ 2068 /** 2069 * Obtains the Base64 code of the image resource corresponding to the specified resource name in callback mode. 2070 * 2071 * @param { string } resName - Indicates the resource name. 2072 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 2073 * resource. 2074 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2075 * @throws { BusinessError } 9001003 - Invalid resource name. 2076 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2077 * @syscap SystemCapability.Global.ResourceManager 2078 * @crossplatform 2079 * @since 10 2080 */ 2081 /** 2082 * Obtains the Base64 code of the image resource corresponding to the specified resource name in callback mode. 2083 * 2084 * @param { string } resName - Indicates the resource name. 2085 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 2086 * resource. 2087 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2088 * @throws { BusinessError } 9001003 - Invalid resource name. 2089 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2090 * @syscap SystemCapability.Global.ResourceManager 2091 * @crossplatform 2092 * @atomicservice 2093 * @since 11 2094 */ 2095 getMediaBase64ByName(resName: string, callback: _AsyncCallback<string>): void; 2096 2097 /** 2098 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource name in callback mode. 2099 * 2100 * @param { string } resName - Indicates the resource name. 2101 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 2102 * to use the density of current system dpi. 2103 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the 2104 * specified screen density image resource. 2105 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 2106 * @throws { BusinessError } 9001003 - Invalid resource name. 2107 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2108 * @syscap SystemCapability.Global.ResourceManager 2109 * @since 10 2110 */ 2111 /** 2112 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource name in callback mode. 2113 * 2114 * @param { string } resName - Indicates the resource name. 2115 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 2116 * to use the density of current system dpi. 2117 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the 2118 * specified screen density image resource. 2119 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 2120 * @throws { BusinessError } 9001003 - Invalid resource name. 2121 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2122 * @syscap SystemCapability.Global.ResourceManager 2123 * @crossplatform 2124 * @atomicservice 2125 * @since 11 2126 */ 2127 getMediaBase64ByName(resName: string, density: number, callback: _AsyncCallback<string>): void; 2128 2129 /** 2130 * Obtains the Base64 code of the image resource corresponding to the specified resource name in Promise mode. 2131 * 2132 * @param { string } resName - Indicates the resource name. 2133 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource name. 2134 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2135 * @throws { BusinessError } 9001003 - Invalid resource name. 2136 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2137 * @syscap SystemCapability.Global.ResourceManager 2138 * @since 9 2139 */ 2140 /** 2141 * Obtains the Base64 code of the image resource corresponding to the specified resource name in Promise mode. 2142 * 2143 * @param { string } resName - Indicates the resource name. 2144 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource name. 2145 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2146 * @throws { BusinessError } 9001003 - Invalid resource name. 2147 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2148 * @syscap SystemCapability.Global.ResourceManager 2149 * @crossplatform 2150 * @since 10 2151 */ 2152 /** 2153 * Obtains the Base64 code of the image resource corresponding to the specified resource name in Promise mode. 2154 * 2155 * @param { string } resName - Indicates the resource name. 2156 * @returns { Promise<string> } The Base64 code of the image resource corresponding to the specified resource name. 2157 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2158 * @throws { BusinessError } 9001003 - Invalid resource name. 2159 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2160 * @syscap SystemCapability.Global.ResourceManager 2161 * @crossplatform 2162 * @atomicservice 2163 * @since 11 2164 */ 2165 getMediaBase64ByName(resName: string): Promise<string>; 2166 2167 /** 2168 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource name in Promise mode. 2169 * 2170 * @param { string } resName - Indicates the resource name. 2171 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 2172 * to use the density of current system dpi. 2173 * @returns { Promise<string> } The Base64 code of the specified screen density image resource corresponding to the specified resource name. 2174 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 2175 * @throws { BusinessError } 9001003 - Invalid resource name. 2176 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2177 * @syscap SystemCapability.Global.ResourceManager 2178 * @since 10 2179 */ 2180 /** 2181 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource name in Promise mode. 2182 * 2183 * @param { string } resName - Indicates the resource name. 2184 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 2185 * to use the density of current system dpi. 2186 * @returns { Promise<string> } The Base64 code of the specified screen density image resource corresponding to the specified resource name. 2187 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 2188 * @throws { BusinessError } 9001003 - Invalid resource name. 2189 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2190 * @syscap SystemCapability.Global.ResourceManager 2191 * @crossplatform 2192 * @atomicservice 2193 * @since 11 2194 */ 2195 getMediaBase64ByName(resName: string, density: number): Promise<string>; 2196 2197 /** 2198 * Obtains the singular-plural character string represented by the name string corresponding to the 2199 * specified number in callback mode. 2200 * 2201 * @param { string } resName - Indicates the resource name. 2202 * @param { number } num - Indicates the number. 2203 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 2204 * string represented by the name string corresponding to the specified number. 2205 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2206 * @throws { BusinessError } 9001003 - Invalid resource name. 2207 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2208 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2209 * @syscap SystemCapability.Global.ResourceManager 2210 * @since 9 2211 */ 2212 /** 2213 * Obtains the singular-plural character string represented by the name string corresponding to the 2214 * specified number in callback mode. 2215 * 2216 * @param { string } resName - Indicates the resource name. 2217 * @param { number } num - Indicates the number. 2218 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 2219 * string represented by the name string corresponding to the specified number. 2220 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2221 * @throws { BusinessError } 9001003 - Invalid resource name. 2222 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2223 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2224 * @syscap SystemCapability.Global.ResourceManager 2225 * @crossplatform 2226 * @since 10 2227 */ 2228 /** 2229 * Obtains the singular-plural character string represented by the name string corresponding to the 2230 * specified number in callback mode. 2231 * 2232 * @param { string } resName - Indicates the resource name. 2233 * @param { number } num - Indicates the number. 2234 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 2235 * string represented by the name string corresponding to the specified number. 2236 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2237 * @throws { BusinessError } 9001003 - Invalid resource name. 2238 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2239 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2240 * @syscap SystemCapability.Global.ResourceManager 2241 * @crossplatform 2242 * @atomicservice 2243 * @since 11 2244 */ 2245 getPluralStringByName(resName: string, num: number, callback: _AsyncCallback<string>): void; 2246 2247 /** 2248 * Obtains the singular-plural character string represented by the name string corresponding to 2249 * the specified number in Promise mode. 2250 * 2251 * @param { string } resName - Indicates the resource name. 2252 * @param { number } num - Indicates the number. 2253 * @returns { Promise<string> } the singular-plural character string represented by the name string 2254 * corresponding to the specified number. 2255 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2256 * @throws { BusinessError } 9001003 - Invalid resource name. 2257 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2258 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2259 * @syscap SystemCapability.Global.ResourceManager 2260 * @since 9 2261 */ 2262 /** 2263 * Obtains the singular-plural character string represented by the name string corresponding to 2264 * the specified number in Promise mode. 2265 * 2266 * @param { string } resName - Indicates the resource name. 2267 * @param { number } num - Indicates the number. 2268 * @returns { Promise<string> } the singular-plural character string represented by the name string 2269 * corresponding to the specified number. 2270 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2271 * @throws { BusinessError } 9001003 - Invalid resource name. 2272 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2273 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2274 * @syscap SystemCapability.Global.ResourceManager 2275 * @crossplatform 2276 * @since 10 2277 */ 2278 /** 2279 * Obtains the singular-plural character string represented by the name string corresponding to 2280 * the specified number in Promise mode. 2281 * 2282 * @param { string } resName - Indicates the resource name. 2283 * @param { number } num - Indicates the number. 2284 * @returns { Promise<string> } the singular-plural character string represented by the name string 2285 * corresponding to the specified number. 2286 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2287 * @throws { BusinessError } 9001003 - Invalid resource name. 2288 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2289 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2290 * @syscap SystemCapability.Global.ResourceManager 2291 * @crossplatform 2292 * @atomicservice 2293 * @since 11 2294 */ 2295 getPluralStringByName(resName: string, num: number): Promise<string>; 2296 2297 /** 2298 * Obtains string resources associated with a specified resource ID. 2299 * 2300 * @param { number } resId - Indicates the resource ID. 2301 * @returns { string } The character string corresponding to the resource ID. 2302 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2303 * @throws { BusinessError } 9001001 - Invalid resource ID. 2304 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2305 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2306 * @syscap SystemCapability.Global.ResourceManager 2307 * @since 9 2308 */ 2309 /** 2310 * Obtains string resources associated with a specified resource ID. 2311 * 2312 * @param { number } resId - Indicates the resource ID. 2313 * @returns { string } The character string corresponding to the resource ID. 2314 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2315 * @throws { BusinessError } 9001001 - Invalid resource ID. 2316 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2317 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2318 * @syscap SystemCapability.Global.ResourceManager 2319 * @crossplatform 2320 * @since 10 2321 */ 2322 /** 2323 * Obtains string resources associated with a specified resource ID. 2324 * 2325 * @param { number } resId - Indicates the resource ID. 2326 * @returns { string } The character string corresponding to the resource ID. 2327 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2328 * @throws { BusinessError } 9001001 - Invalid resource ID. 2329 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2330 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2331 * @syscap SystemCapability.Global.ResourceManager 2332 * @crossplatform 2333 * @atomicservice 2334 * @since 11 2335 */ 2336 getStringSync(resId: number): string; 2337 2338 /** 2339 * Obtains string resources associated with a specified resource ID. 2340 * 2341 * @param { number } resId - Indicates the resource ID. 2342 * @param { Array<string | number> } args - Indicates the formatting string resource parameters. 2343 * @returns { string } The character string corresponding to the resource ID. 2344 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2345 * @throws { BusinessError } 9001001 - Invalid resource ID. 2346 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2347 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2348 * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. 2349 * @syscap SystemCapability.Global.ResourceManager 2350 * @crossplatform 2351 * @since 10 2352 */ 2353 /** 2354 * Obtains string resources associated with a specified resource ID. 2355 * 2356 * @param { number } resId - Indicates the resource ID. 2357 * @param { Array<string | number> } args - Indicates the formatting string resource parameters. 2358 * @returns { string } The character string corresponding to the resource ID. 2359 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2360 * @throws { BusinessError } 9001001 - Invalid resource ID. 2361 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2362 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2363 * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. 2364 * @syscap SystemCapability.Global.ResourceManager 2365 * @crossplatform 2366 * @atomicservice 2367 * @since 11 2368 */ 2369 getStringSync(resId: number, ...args: Array<string | number>): string; 2370 2371 /** 2372 * Obtains string resources associated with a specified resource object. 2373 * 2374 * @param { Resource } resource - Indicates the resource object. 2375 * @returns { string } The character string corresponding to the resource object. 2376 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2377 * @throws { BusinessError } 9001001 - Invalid resource ID. 2378 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2379 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2380 * @syscap SystemCapability.Global.ResourceManager 2381 * @stagemodelonly 2382 * @since 9 2383 */ 2384 /** 2385 * Obtains string resources associated with a specified resource object. 2386 * 2387 * @param { Resource } resource - Indicates the resource object. 2388 * @returns { string } The character string corresponding to the resource object. 2389 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2390 * @throws { BusinessError } 9001001 - Invalid resource ID. 2391 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2392 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2393 * @syscap SystemCapability.Global.ResourceManager 2394 * @stagemodelonly 2395 * @crossplatform 2396 * @since 10 2397 */ 2398 /** 2399 * Obtains string resources associated with a specified resource object. 2400 * 2401 * @param { Resource } resource - Indicates the resource object. 2402 * @returns { string } The character string corresponding to the resource object. 2403 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2404 * @throws { BusinessError } 9001001 - Invalid resource ID. 2405 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2406 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2407 * @syscap SystemCapability.Global.ResourceManager 2408 * @stagemodelonly 2409 * @crossplatform 2410 * @atomicservice 2411 * @since 11 2412 */ 2413 getStringSync(resource: Resource): string; 2414 2415 /** 2416 * Obtains string resources associated with a specified resource object. 2417 * 2418 * @param { Resource } resource - Indicates the resource object. 2419 * @param { Array<string | number> } args - Indicates the formatting string resource parameters. 2420 * @returns { string } The character string corresponding to the resource object. 2421 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2422 * @throws { BusinessError } 9001001 - Invalid resource ID. 2423 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2424 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2425 * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. 2426 * @syscap SystemCapability.Global.ResourceManager 2427 * @stagemodelonly 2428 * @crossplatform 2429 * @since 10 2430 */ 2431 /** 2432 * Obtains string resources associated with a specified resource object. 2433 * 2434 * @param { Resource } resource - Indicates the resource object. 2435 * @param { Array<string | number> } args - Indicates the formatting string resource parameters. 2436 * @returns { string } The character string corresponding to the resource object. 2437 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2438 * @throws { BusinessError } 9001001 - Invalid resource ID. 2439 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2440 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2441 * @throws { BusinessError } 9001007 - Failed to format the resource obtained based on the resource ID. 2442 * @syscap SystemCapability.Global.ResourceManager 2443 * @stagemodelonly 2444 * @crossplatform 2445 * @atomicservice 2446 * @since 11 2447 */ 2448 getStringSync(resource: Resource, ...args: Array<string | number>): string; 2449 2450 /** 2451 * Obtains string resources associated with a specified resource name. 2452 * 2453 * @param { string } resName - Indicates the resource name. 2454 * @returns { string } The character string corresponding to the resource name. 2455 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2456 * @throws { BusinessError } 9001003 - Invalid resource name. 2457 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2458 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2459 * @syscap SystemCapability.Global.ResourceManager 2460 * @since 9 2461 */ 2462 /** 2463 * Obtains string resources associated with a specified resource name. 2464 * 2465 * @param { string } resName - Indicates the resource name. 2466 * @returns { string } The character string corresponding to the resource name. 2467 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2468 * @throws { BusinessError } 9001003 - Invalid resource name. 2469 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2470 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2471 * @syscap SystemCapability.Global.ResourceManager 2472 * @crossplatform 2473 * @since 10 2474 */ 2475 /** 2476 * Obtains string resources associated with a specified resource name. 2477 * 2478 * @param { string } resName - Indicates the resource name. 2479 * @returns { string } The character string corresponding to the resource name. 2480 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2481 * @throws { BusinessError } 9001003 - Invalid resource name. 2482 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2483 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2484 * @syscap SystemCapability.Global.ResourceManager 2485 * @crossplatform 2486 * @atomicservice 2487 * @since 11 2488 */ 2489 getStringByNameSync(resName: string): string; 2490 2491 /** 2492 * Obtains string resources associated with a specified resource name. 2493 * 2494 * @param { string } resName - Indicates the resource name. 2495 * @param { Array<string | number> } args - Indicates the formatting string resource parameters. 2496 * @returns { string } The character string corresponding to the resource name. 2497 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2498 * @throws { BusinessError } 9001003 - Invalid resource name. 2499 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2500 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2501 * @throws { BusinessError } 9001008 - Failed to format the resource obtained based on the resource Name. 2502 * @syscap SystemCapability.Global.ResourceManager 2503 * @crossplatform 2504 * @since 10 2505 */ 2506 /** 2507 * Obtains string resources associated with a specified resource name. 2508 * 2509 * @param { string } resName - Indicates the resource name. 2510 * @param { Array<string | number> } args - Indicates the formatting string resource parameters. 2511 * @returns { string } The character string corresponding to the resource name. 2512 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2513 * @throws { BusinessError } 9001003 - Invalid resource name. 2514 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2515 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2516 * @throws { BusinessError } 9001008 - Failed to format the resource obtained based on the resource Name. 2517 * @syscap SystemCapability.Global.ResourceManager 2518 * @crossplatform 2519 * @atomicservice 2520 * @since 11 2521 */ 2522 getStringByNameSync(resName: string, ...args: Array<string | number>): string; 2523 2524 /** 2525 * Obtains the boolean result with a specified resource ID. 2526 * 2527 * @param { number } resId - Indicates the resource ID. 2528 * @returns { boolean } The boolean resource corresponding to the resource ID. 2529 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2530 * @throws { BusinessError } 9001001 - Invalid resource ID. 2531 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2532 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2533 * @syscap SystemCapability.Global.ResourceManager 2534 * @since 9 2535 */ 2536 /** 2537 * Obtains the boolean result with a specified resource ID. 2538 * 2539 * @param { number } resId - Indicates the resource ID. 2540 * @returns { boolean } The boolean resource corresponding to the resource ID. 2541 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2542 * @throws { BusinessError } 9001001 - Invalid resource ID. 2543 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2544 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2545 * @syscap SystemCapability.Global.ResourceManager 2546 * @crossplatform 2547 * @since 10 2548 */ 2549 /** 2550 * Obtains the boolean result with a specified resource ID. 2551 * 2552 * @param { number } resId - Indicates the resource ID. 2553 * @returns { boolean } The boolean resource corresponding to the resource ID. 2554 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2555 * @throws { BusinessError } 9001001 - Invalid resource ID. 2556 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2557 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2558 * @syscap SystemCapability.Global.ResourceManager 2559 * @crossplatform 2560 * @atomicservice 2561 * @since 11 2562 */ 2563 getBoolean(resId: number): boolean; 2564 2565 /** 2566 * Obtains the boolean result with a specified resource object. 2567 * 2568 * @param { Resource } resource - Indicates the resource object. 2569 * @returns { boolean } The boolean resource corresponding to the resource object. 2570 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2571 * @throws { BusinessError } 9001001 - Invalid resource ID. 2572 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2573 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2574 * @syscap SystemCapability.Global.ResourceManager 2575 * @stagemodelonly 2576 * @since 9 2577 */ 2578 /** 2579 * Obtains the boolean result with a specified resource object. 2580 * 2581 * @param { Resource } resource - Indicates the resource object. 2582 * @returns { boolean } The boolean resource corresponding to the resource object. 2583 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2584 * @throws { BusinessError } 9001001 - Invalid resource ID. 2585 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2586 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2587 * @syscap SystemCapability.Global.ResourceManager 2588 * @stagemodelonly 2589 * @crossplatform 2590 * @since 10 2591 */ 2592 /** 2593 * Obtains the boolean result with a specified resource object. 2594 * 2595 * @param { Resource } resource - Indicates the resource object. 2596 * @returns { boolean } The boolean resource corresponding to the resource object. 2597 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2598 * @throws { BusinessError } 9001001 - Invalid resource ID. 2599 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2600 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2601 * @syscap SystemCapability.Global.ResourceManager 2602 * @stagemodelonly 2603 * @crossplatform 2604 * @atomicservice 2605 * @since 11 2606 */ 2607 getBoolean(resource: Resource): boolean; 2608 2609 /** 2610 * Obtains the boolean result with a specified resource name. 2611 * 2612 * @param { string } resName - Indicates the resource name. 2613 * @returns { boolean } The boolean resource corresponding to the resource name. 2614 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2615 * @throws { BusinessError } 9001003 - Invalid resource name. 2616 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2617 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2618 * @syscap SystemCapability.Global.ResourceManager 2619 * @since 9 2620 */ 2621 /** 2622 * Obtains the boolean result with a specified resource name. 2623 * 2624 * @param { string } resName - Indicates the resource name. 2625 * @returns { boolean } The boolean resource corresponding to the resource name. 2626 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2627 * @throws { BusinessError } 9001003 - Invalid resource name. 2628 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2629 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2630 * @syscap SystemCapability.Global.ResourceManager 2631 * @crossplatform 2632 * @since 10 2633 */ 2634 /** 2635 * Obtains the boolean result with a specified resource name. 2636 * 2637 * @param { string } resName - Indicates the resource name. 2638 * @returns { boolean } The boolean resource corresponding to the resource name. 2639 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2640 * @throws { BusinessError } 9001003 - Invalid resource name. 2641 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2642 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2643 * @syscap SystemCapability.Global.ResourceManager 2644 * @crossplatform 2645 * @atomicservice 2646 * @since 11 2647 */ 2648 getBooleanByName(resName: string): boolean; 2649 2650 /** 2651 * Obtains the number result with a specified resource ID. 2652 * 2653 * @param { number } resId - Indicates the resource ID. 2654 * @returns { number } The number resource corresponding to the resource ID. 2655 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2656 * @throws { BusinessError } 9001001 - Invalid resource ID. 2657 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2658 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2659 * @syscap SystemCapability.Global.ResourceManager 2660 * @since 9 2661 */ 2662 /** 2663 * Obtains the number result with a specified resource ID. 2664 * 2665 * @param { number } resId - Indicates the resource ID. 2666 * @returns { number } The number resource corresponding to the resource ID. 2667 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2668 * @throws { BusinessError } 9001001 - Invalid resource ID. 2669 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2670 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2671 * @syscap SystemCapability.Global.ResourceManager 2672 * @crossplatform 2673 * @since 10 2674 */ 2675 /** 2676 * Obtains the number result with a specified resource ID. 2677 * 2678 * @param { number } resId - Indicates the resource ID. 2679 * @returns { number } The number resource corresponding to the resource ID. 2680 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2681 * @throws { BusinessError } 9001001 - Invalid resource ID. 2682 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2683 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2684 * @syscap SystemCapability.Global.ResourceManager 2685 * @crossplatform 2686 * @atomicservice 2687 * @since 11 2688 */ 2689 getNumber(resId: number): number; 2690 2691 /** 2692 * Obtains the number result with a specified resource object. 2693 * 2694 * @param { Resource } resource - Indicates the resource object. 2695 * @returns { number } The number resource corresponding to the resource object. 2696 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2697 * @throws { BusinessError } 9001001 - Invalid resource ID. 2698 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2699 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2700 * @syscap SystemCapability.Global.ResourceManager 2701 * @stagemodelonly 2702 * @since 9 2703 */ 2704 /** 2705 * Obtains the number result with a specified resource object. 2706 * 2707 * @param { Resource } resource - Indicates the resource object. 2708 * @returns { number } The number resource corresponding to the resource object. 2709 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2710 * @throws { BusinessError } 9001001 - Invalid resource ID. 2711 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2712 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2713 * @syscap SystemCapability.Global.ResourceManager 2714 * @stagemodelonly 2715 * @crossplatform 2716 * @since 10 2717 */ 2718 /** 2719 * Obtains the number result with a specified resource object. 2720 * 2721 * @param { Resource } resource - Indicates the resource object. 2722 * @returns { number } The number resource corresponding to the resource object. 2723 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2724 * @throws { BusinessError } 9001001 - Invalid resource ID. 2725 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2726 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2727 * @syscap SystemCapability.Global.ResourceManager 2728 * @stagemodelonly 2729 * @crossplatform 2730 * @atomicservice 2731 * @since 11 2732 */ 2733 getNumber(resource: Resource): number; 2734 2735 /** 2736 * Obtains the number result with a specified resource name. 2737 * 2738 * @param { string } resName - Indicates the resource name. 2739 * @returns { number } The number resource corresponding to the resource name. 2740 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2741 * @throws { BusinessError } 9001003 - Invalid resource name. 2742 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2743 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2744 * @syscap SystemCapability.Global.ResourceManager 2745 * @since 9 2746 */ 2747 /** 2748 * Obtains the number result with a specified resource name. 2749 * 2750 * @param { string } resName - Indicates the resource name. 2751 * @returns { number } The number resource corresponding to the resource name. 2752 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2753 * @throws { BusinessError } 9001003 - Invalid resource name. 2754 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2755 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2756 * @syscap SystemCapability.Global.ResourceManager 2757 * @crossplatform 2758 * @since 10 2759 */ 2760 /** 2761 * Obtains the number result with a specified resource name. 2762 * 2763 * @param { string } resName - Indicates the resource name. 2764 * @returns { number } The number resource corresponding to the resource name. 2765 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2766 * @throws { BusinessError } 9001003 - Invalid resource name. 2767 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 2768 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2769 * @syscap SystemCapability.Global.ResourceManager 2770 * @crossplatform 2771 * @atomicservice 2772 * @since 11 2773 */ 2774 getNumberByName(resName: string): number; 2775 2776 /** 2777 * Obtains release resourceManager. 2778 * 2779 * @syscap SystemCapability.Global.ResourceManager 2780 * @since 7 2781 */ 2782 /** 2783 * Obtains release resourceManager. 2784 * 2785 * @syscap SystemCapability.Global.ResourceManager 2786 * @crossplatform 2787 * @since 10 2788 */ 2789 /** 2790 * Obtains release resourceManager. 2791 * 2792 * @syscap SystemCapability.Global.ResourceManager 2793 * @crossplatform 2794 * @atomicservice 2795 * @since 11 2796 * @deprecated since 12 2797 */ 2798 release(); 2799 2800 /** 2801 * Obtains the character string corresponding to a specified resource ID in callback mode. 2802 * 2803 * @param { number } resId - Indicates the resource ID. 2804 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 2805 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2806 * @throws { BusinessError } 9001001 - Invalid resource ID. 2807 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2808 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2809 * @syscap SystemCapability.Global.ResourceManager 2810 * @since 9 2811 */ 2812 /** 2813 * Obtains the character string corresponding to a specified resource ID in callback mode. 2814 * 2815 * @param { number } resId - Indicates the resource ID. 2816 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 2817 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2818 * @throws { BusinessError } 9001001 - Invalid resource ID. 2819 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2820 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2821 * @syscap SystemCapability.Global.ResourceManager 2822 * @crossplatform 2823 * @since 10 2824 */ 2825 /** 2826 * Obtains the character string corresponding to a specified resource ID in callback mode. 2827 * 2828 * @param { number } resId - Indicates the resource ID. 2829 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained character string. 2830 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2831 * @throws { BusinessError } 9001001 - Invalid resource ID. 2832 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2833 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2834 * @syscap SystemCapability.Global.ResourceManager 2835 * @crossplatform 2836 * @atomicservice 2837 * @since 11 2838 */ 2839 getStringValue(resId: number, callback: _AsyncCallback<string>): void; 2840 2841 /** 2842 * Obtains string resources associated with a specified resource ID in Promise mode. 2843 * 2844 * @param { number } resId - Indicates the resource ID. 2845 * @returns { Promise<string> } The character string corresponding to the resource ID. 2846 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2847 * @throws { BusinessError } 9001001 - Invalid resource ID. 2848 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2849 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2850 * @syscap SystemCapability.Global.ResourceManager 2851 * @since 9 2852 */ 2853 /** 2854 * Obtains string resources associated with a specified resource ID in Promise mode. 2855 * 2856 * @param { number } resId - Indicates the resource ID. 2857 * @returns { Promise<string> } The character string corresponding to the resource ID. 2858 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2859 * @throws { BusinessError } 9001001 - Invalid resource ID. 2860 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2861 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2862 * @syscap SystemCapability.Global.ResourceManager 2863 * @crossplatform 2864 * @since 10 2865 */ 2866 /** 2867 * Obtains string resources associated with a specified resource ID in Promise mode. 2868 * 2869 * @param { number } resId - Indicates the resource ID. 2870 * @returns { Promise<string> } The character string corresponding to the resource ID. 2871 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2872 * @throws { BusinessError } 9001001 - Invalid resource ID. 2873 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2874 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2875 * @syscap SystemCapability.Global.ResourceManager 2876 * @crossplatform 2877 * @atomicservice 2878 * @since 11 2879 */ 2880 getStringValue(resId: number): Promise<string>; 2881 2882 /** 2883 * Obtains the array of character strings corresponding to a specified resource ID in callback mode. 2884 * 2885 * @param { number } resId - Indicates the resource ID. 2886 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 2887 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2888 * @throws { BusinessError } 9001001 - Invalid resource ID. 2889 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2890 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2891 * @syscap SystemCapability.Global.ResourceManager 2892 * @since 9 2893 */ 2894 /** 2895 * Obtains the array of character strings corresponding to a specified resource ID in callback mode. 2896 * 2897 * @param { number } resId - Indicates the resource ID. 2898 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 2899 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2900 * @throws { BusinessError } 9001001 - Invalid resource ID. 2901 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2902 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2903 * @syscap SystemCapability.Global.ResourceManager 2904 * @crossplatform 2905 * @since 10 2906 */ 2907 /** 2908 * Obtains the array of character strings corresponding to a specified resource ID in callback mode. 2909 * 2910 * @param { number } resId - Indicates the resource ID. 2911 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the obtained array of character strings. 2912 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2913 * @throws { BusinessError } 9001001 - Invalid resource ID. 2914 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2915 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2916 * @syscap SystemCapability.Global.ResourceManager 2917 * @crossplatform 2918 * @atomicservice 2919 * @since 11 2920 */ 2921 getStringArrayValue(resId: number, callback: _AsyncCallback<Array<string>>): void; 2922 2923 /** 2924 * Obtains the array of character strings corresponding to a specified resource ID in Promise mode. 2925 * 2926 * @param { number } resId - Indicates the resource ID. 2927 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource ID. 2928 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2929 * @throws { BusinessError } 9001001 - Invalid resource ID. 2930 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2931 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2932 * @syscap SystemCapability.Global.ResourceManager 2933 * @since 9 2934 */ 2935 /** 2936 * Obtains the array of character strings corresponding to a specified resource ID in Promise mode. 2937 * 2938 * @param { number } resId - Indicates the resource ID. 2939 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource ID. 2940 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2941 * @throws { BusinessError } 9001001 - Invalid resource ID. 2942 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2943 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2944 * @syscap SystemCapability.Global.ResourceManager 2945 * @crossplatform 2946 * @since 10 2947 */ 2948 /** 2949 * Obtains the array of character strings corresponding to a specified resource ID in Promise mode. 2950 * 2951 * @param { number } resId - Indicates the resource ID. 2952 * @returns { Promise<Array<string>> } The array of character strings corresponding to the specified resource ID. 2953 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2954 * @throws { BusinessError } 9001001 - Invalid resource ID. 2955 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2956 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2957 * @syscap SystemCapability.Global.ResourceManager 2958 * @crossplatform 2959 * @atomicservice 2960 * @since 11 2961 */ 2962 getStringArrayValue(resId: number): Promise<Array<string>>; 2963 2964 /** 2965 * Obtains the singular-plural character string represented by the ID string corresponding to the 2966 * specified number in callback mode. 2967 * 2968 * @param { number } resId - Indicates the resource ID. 2969 * @param { number } num - Indicates the number. 2970 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 2971 * string represented by the ID string corresponding to the specified number. 2972 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2973 * @throws { BusinessError } 9001001 - Invalid resource ID. 2974 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2975 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2976 * @syscap SystemCapability.Global.ResourceManager 2977 * @since 9 2978 */ 2979 /** 2980 * Obtains the singular-plural character string represented by the ID string corresponding to the 2981 * specified number in callback mode. 2982 * 2983 * @param { number } resId - Indicates the resource ID. 2984 * @param { number } num - Indicates the number. 2985 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 2986 * string represented by the ID string corresponding to the specified number. 2987 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 2988 * @throws { BusinessError } 9001001 - Invalid resource ID. 2989 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 2990 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 2991 * @syscap SystemCapability.Global.ResourceManager 2992 * @crossplatform 2993 * @since 10 2994 */ 2995 /** 2996 * Obtains the singular-plural character string represented by the ID string corresponding to the 2997 * specified number in callback mode. 2998 * 2999 * @param { number } resId - Indicates the resource ID. 3000 * @param { number } num - Indicates the number. 3001 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the singular-plural character 3002 * string represented by the ID string corresponding to the specified number. 3003 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3004 * @throws { BusinessError } 9001001 - Invalid resource ID. 3005 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3006 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3007 * @syscap SystemCapability.Global.ResourceManager 3008 * @crossplatform 3009 * @atomicservice 3010 * @since 11 3011 */ 3012 getPluralStringValue(resId: number, num: number, callback: _AsyncCallback<string>): void; 3013 3014 /** 3015 * Obtains the singular-plural character string represented by the ID string corresponding to 3016 * the specified number in Promise mode. 3017 * 3018 * @param { number } resId - Indicates the resource ID. 3019 * @param { number } num - Indicates the number. 3020 * @returns { Promise<string> } The singular-plural character string represented by the ID string 3021 * corresponding to the specified number. 3022 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3023 * @throws { BusinessError } 9001001 - Invalid resource ID. 3024 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3025 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3026 * @syscap SystemCapability.Global.ResourceManager 3027 * @since 9 3028 */ 3029 /** 3030 * Obtains the singular-plural character string represented by the ID string corresponding to 3031 * the specified number in Promise mode. 3032 * 3033 * @param { number } resId - Indicates the resource ID. 3034 * @param { number } num - Indicates the number. 3035 * @returns { Promise<string> } The singular-plural character string represented by the ID string 3036 * corresponding to the specified number. 3037 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3038 * @throws { BusinessError } 9001001 - Invalid resource ID. 3039 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3040 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3041 * @syscap SystemCapability.Global.ResourceManager 3042 * @crossplatform 3043 * @since 10 3044 */ 3045 /** 3046 * Obtains the singular-plural character string represented by the ID string corresponding to 3047 * the specified number in Promise mode. 3048 * 3049 * @param { number } resId - Indicates the resource ID. 3050 * @param { number } num - Indicates the number. 3051 * @returns { Promise<string> } The singular-plural character string represented by the ID string 3052 * corresponding to the specified number. 3053 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3054 * @throws { BusinessError } 9001001 - Invalid resource ID. 3055 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3056 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3057 * @syscap SystemCapability.Global.ResourceManager 3058 * @crossplatform 3059 * @atomicservice 3060 * @since 11 3061 */ 3062 getPluralStringValue(resId: number, num: number): Promise<string>; 3063 3064 /** 3065 * Obtains the content of the media file corresponding to a specified resource ID in callback mode. 3066 * 3067 * @param { number } resId - Indicates the resource ID. 3068 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 3069 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3070 * @throws { BusinessError } 9001001 - Invalid resource ID. 3071 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3072 * @syscap SystemCapability.Global.ResourceManager 3073 * @since 9 3074 */ 3075 /** 3076 * Obtains the content of the media file corresponding to a specified resource ID in callback mode. 3077 * 3078 * @param { number } resId - Indicates the resource ID. 3079 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 3080 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3081 * @throws { BusinessError } 9001001 - Invalid resource ID. 3082 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3083 * @syscap SystemCapability.Global.ResourceManager 3084 * @crossplatform 3085 * @since 10 3086 */ 3087 /** 3088 * Obtains the content of the media file corresponding to a specified resource ID in callback mode. 3089 * 3090 * @param { number } resId - Indicates the resource ID. 3091 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained media file content. 3092 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3093 * @throws { BusinessError } 9001001 - Invalid resource ID. 3094 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3095 * @syscap SystemCapability.Global.ResourceManager 3096 * @crossplatform 3097 * @atomicservice 3098 * @since 11 3099 */ 3100 getMediaContent(resId: number, callback: _AsyncCallback<Uint8Array>): void; 3101 3102 /** 3103 * Obtains the content of the specified screen density media file corresponding to a specified resource ID in callback mode. 3104 * 3105 * @param { number } resId - Indicates the resource ID. 3106 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3107 * to use the density of current system dpi. 3108 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained 3109 * specified screen density media file content. 3110 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3111 * @throws { BusinessError } 9001001 - Invalid resource ID. 3112 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3113 * @syscap SystemCapability.Global.ResourceManager 3114 * @since 10 3115 */ 3116 /** 3117 * Obtains the content of the specified screen density media file corresponding to a specified resource ID in callback mode. 3118 * 3119 * @param { number } resId - Indicates the resource ID. 3120 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3121 * to use the density of current system dpi. 3122 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the obtained 3123 * specified screen density media file content. 3124 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3125 * @throws { BusinessError } 9001001 - Invalid resource ID. 3126 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3127 * @syscap SystemCapability.Global.ResourceManager 3128 * @crossplatform 3129 * @atomicservice 3130 * @since 11 3131 */ 3132 getMediaContent(resId: number, density: number, callback: _AsyncCallback<Uint8Array>): void; 3133 3134 /** 3135 * Obtains the content of the media file corresponding to a specified resource ID in Promise mode. 3136 * 3137 * @param { number } resId - Indicates the resource ID. 3138 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource ID. 3139 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3140 * @throws { BusinessError } 9001001 - Invalid resource ID. 3141 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3142 * @syscap SystemCapability.Global.ResourceManager 3143 * @since 9 3144 */ 3145 /** 3146 * Obtains the content of the media file corresponding to a specified resource ID in Promise mode. 3147 * 3148 * @param { number } resId - Indicates the resource ID. 3149 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource ID. 3150 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3151 * @throws { BusinessError } 9001001 - Invalid resource ID. 3152 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3153 * @syscap SystemCapability.Global.ResourceManager 3154 * @crossplatform 3155 * @since 10 3156 */ 3157 /** 3158 * Obtains the content of the media file corresponding to a specified resource ID in Promise mode. 3159 * 3160 * @param { number } resId - Indicates the resource ID. 3161 * @returns { Promise<Uint8Array> } The content of the media file corresponding to the specified resource ID. 3162 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3163 * @throws { BusinessError } 9001001 - Invalid resource ID. 3164 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3165 * @syscap SystemCapability.Global.ResourceManager 3166 * @crossplatform 3167 * @atomicservice 3168 * @since 11 3169 */ 3170 getMediaContent(resId: number): Promise<Uint8Array>; 3171 3172 /** 3173 * Obtains the content of the specified screen density media file corresponding to a specified resource ID in Promise mode. 3174 * 3175 * @param { number } resId - Indicates the resource ID. 3176 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3177 * to use the density of current system dpi. 3178 * @returns { Promise<Uint8Array> } The content of the specified screen density media file corresponding to the specified resource ID. 3179 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3180 * @throws { BusinessError } 9001001 - Invalid resource ID. 3181 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3182 * @syscap SystemCapability.Global.ResourceManager 3183 * @since 10 3184 */ 3185 /** 3186 * Obtains the content of the specified screen density media file corresponding to a specified resource ID in Promise mode. 3187 * 3188 * @param { number } resId - Indicates the resource ID. 3189 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3190 * to use the density of current system dpi. 3191 * @returns { Promise<Uint8Array> } The content of the specified screen density media file corresponding to the specified resource ID. 3192 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3193 * @throws { BusinessError } 9001001 - Invalid resource ID. 3194 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3195 * @syscap SystemCapability.Global.ResourceManager 3196 * @crossplatform 3197 * @atomicservice 3198 * @since 11 3199 */ 3200 getMediaContent(resId: number, density: number): Promise<Uint8Array>; 3201 3202 /** 3203 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in callback mode. 3204 * 3205 * @param { number } resId - Indicates the resource ID. 3206 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 3207 * resource. 3208 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3209 * @throws { BusinessError } 9001001 - Invalid resource ID. 3210 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3211 * @syscap SystemCapability.Global.ResourceManager 3212 * @since 9 3213 */ 3214 /** 3215 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in callback mode. 3216 * 3217 * @param { number } resId - Indicates the resource ID. 3218 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 3219 * resource. 3220 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3221 * @throws { BusinessError } 9001001 - Invalid resource ID. 3222 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3223 * @syscap SystemCapability.Global.ResourceManager 3224 * @crossplatform 3225 * @since 10 3226 */ 3227 /** 3228 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in callback mode. 3229 * 3230 * @param { number } resId - Indicates the resource ID. 3231 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the image 3232 * resource. 3233 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3234 * @throws { BusinessError } 9001001 - Invalid resource ID. 3235 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3236 * @syscap SystemCapability.Global.ResourceManager 3237 * @crossplatform 3238 * @atomicservice 3239 * @since 11 3240 */ 3241 getMediaContentBase64(resId: number, callback: _AsyncCallback<string>): void; 3242 3243 /** 3244 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource ID in callback mode. 3245 * 3246 * @param { number } resId - Indicates the resource ID. 3247 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3248 * to use the density of current system dpi. 3249 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the 3250 * specified screen density image resource. 3251 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3252 * @throws { BusinessError } 9001001 - Invalid resource ID. 3253 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3254 * @syscap SystemCapability.Global.ResourceManager 3255 * @since 10 3256 */ 3257 /** 3258 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource ID in callback mode. 3259 * 3260 * @param { number } resId - Indicates the resource ID. 3261 * @param { number } density - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3262 * to use the density of current system dpi. 3263 * @param { _AsyncCallback<string> } callback - Indicates the asynchronous callback used to return the obtained Base64 code of the 3264 * specified screen density image resource. 3265 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3266 * @throws { BusinessError } 9001001 - Invalid resource ID. 3267 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3268 * @syscap SystemCapability.Global.ResourceManager 3269 * @crossplatform 3270 * @atomicservice 3271 * @since 11 3272 */ 3273 getMediaContentBase64(resId: number, density: number, callback: _AsyncCallback<string>): void; 3274 3275 /** 3276 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode. 3277 * 3278 * @param { number } resId - Indicates the resource ID. 3279 * @returns { Promise<string> } the Base64 code of the image resource corresponding to the specified resource ID. 3280 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3281 * @throws { BusinessError } 9001001 - Invalid resource ID. 3282 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3283 * @syscap SystemCapability.Global.ResourceManager 3284 * @since 9 3285 */ 3286 /** 3287 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode. 3288 * 3289 * @param { number } resId - Indicates the resource ID. 3290 * @returns { Promise<string> } the Base64 code of the image resource corresponding to the specified resource ID. 3291 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3292 * @throws { BusinessError } 9001001 - Invalid resource ID. 3293 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3294 * @syscap SystemCapability.Global.ResourceManager 3295 * @crossplatform 3296 * @since 10 3297 */ 3298 /** 3299 * Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode. 3300 * 3301 * @param { number } resId - Indicates the resource ID. 3302 * @returns { Promise<string> } the Base64 code of the image resource corresponding to the specified resource ID. 3303 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3304 * @throws { BusinessError } 9001001 - Invalid resource ID. 3305 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3306 * @syscap SystemCapability.Global.ResourceManager 3307 * @crossplatform 3308 * @atomicservice 3309 * @since 11 3310 */ 3311 getMediaContentBase64(resId: number): Promise<string>; 3312 3313 /** 3314 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource ID in Promise mode. 3315 * 3316 * @param { number } resId - Indicates the resource ID. 3317 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3318 * to use the density of current system dpi. 3319 * @returns { Promise<string> } the Base64 code of the specified screen density image resource corresponding to the specified resource ID. 3320 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3321 * @throws { BusinessError } 9001001 - Invalid resource ID. 3322 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3323 * @syscap SystemCapability.Global.ResourceManager 3324 * @since 10 3325 */ 3326 /** 3327 * Obtains the Base64 code of the specified screen density image resource corresponding to the specified resource ID in Promise mode. 3328 * 3329 * @param { number } resId - Indicates the resource ID. 3330 * @param { number } density - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3331 * to use the density of current system dpi. 3332 * @returns { Promise<string> } the Base64 code of the specified screen density image resource corresponding to the specified resource ID. 3333 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3334 * @throws { BusinessError } 9001001 - Invalid resource ID. 3335 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3336 * @syscap SystemCapability.Global.ResourceManager 3337 * @crossplatform 3338 * @atomicservice 3339 * @since 11 3340 */ 3341 getMediaContentBase64(resId: number, density: number): Promise<string>; 3342 3343 /** 3344 * Obtains the raw file resource corresponding to the specified resource path in callback mode. 3345 * 3346 * @param { string } path - Indicates the resource relative path. 3347 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the raw file resource. 3348 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3349 * @throws { BusinessError } 9001005 - Invalid relative path. 3350 * @syscap SystemCapability.Global.ResourceManager 3351 * @since 9 3352 */ 3353 /** 3354 * Obtains the raw file resource corresponding to the specified resource path in callback mode. 3355 * 3356 * @param { string } path - Indicates the resource relative path. 3357 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the raw file resource. 3358 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3359 * @throws { BusinessError } 9001005 - Invalid relative path. 3360 * @syscap SystemCapability.Global.ResourceManager 3361 * @crossplatform 3362 * @since 10 3363 */ 3364 /** 3365 * Obtains the raw file resource corresponding to the specified resource path in callback mode. 3366 * 3367 * @param { string } path - Indicates the resource relative path. 3368 * @param { _AsyncCallback<Uint8Array> } callback - Indicates the asynchronous callback used to return the raw file resource. 3369 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3370 * @throws { BusinessError } 9001005 - Invalid relative path. 3371 * @syscap SystemCapability.Global.ResourceManager 3372 * @crossplatform 3373 * @atomicservice 3374 * @since 11 3375 */ 3376 getRawFileContent(path: string, callback: _AsyncCallback<Uint8Array>): void; 3377 3378 /** 3379 * Obtains the raw file resource corresponding to the specified resource path in Promise mode. 3380 * 3381 * @param { string } path - Indicates the resource relative path. 3382 * @returns { Promise<Uint8Array> } the raw file resource corresponding to the specified resource path. 3383 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3384 * @throws { BusinessError } 9001005 - Invalid relative path. 3385 * @syscap SystemCapability.Global.ResourceManager 3386 * @since 9 3387 */ 3388 /** 3389 * Obtains the raw file resource corresponding to the specified resource path in Promise mode. 3390 * 3391 * @param { string } path - Indicates the resource relative path. 3392 * @returns { Promise<Uint8Array> } the raw file resource corresponding to the specified resource path. 3393 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3394 * @throws { BusinessError } 9001005 - Invalid relative path. 3395 * @syscap SystemCapability.Global.ResourceManager 3396 * @crossplatform 3397 * @since 10 3398 */ 3399 /** 3400 * Obtains the raw file resource corresponding to the specified resource path in Promise mode. 3401 * 3402 * @param { string } path - Indicates the resource relative path. 3403 * @returns { Promise<Uint8Array> } the raw file resource corresponding to the specified resource path. 3404 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3405 * @throws { BusinessError } 9001005 - Invalid relative path. 3406 * @syscap SystemCapability.Global.ResourceManager 3407 * @crossplatform 3408 * @atomicservice 3409 * @since 11 3410 */ 3411 getRawFileContent(path: string): Promise<Uint8Array>; 3412 3413 /** 3414 * Obtains the raw file resource descriptor corresponding to the specified resource path in callback mode. 3415 * 3416 * @param { string } path - Indicates the resource relative path. 3417 * @param { _AsyncCallback<RawFileDescriptor> } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. 3418 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3419 * @throws { BusinessError } 9001005 - Invalid relative path. 3420 * @syscap SystemCapability.Global.ResourceManager 3421 * @since 9 3422 */ 3423 /** 3424 * Obtains the raw file resource descriptor corresponding to the specified resource path in callback mode. 3425 * 3426 * @param { string } path - Indicates the resource relative path. 3427 * @param { _AsyncCallback<RawFileDescriptor> } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. 3428 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3429 * @throws { BusinessError } 9001005 - Invalid relative path. 3430 * @syscap SystemCapability.Global.ResourceManager 3431 * @crossplatform 3432 * @since 10 3433 */ 3434 /** 3435 * Obtains the raw file resource descriptor corresponding to the specified resource path in callback mode. 3436 * 3437 * @param { string } path - Indicates the resource relative path. 3438 * @param { _AsyncCallback<RawFileDescriptor> } callback - Indicates the asynchronous callback used to return the raw file resource descriptor. 3439 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3440 * @throws { BusinessError } 9001005 - Invalid relative path. 3441 * @syscap SystemCapability.Global.ResourceManager 3442 * @crossplatform 3443 * @atomicservice 3444 * @since 11 3445 */ 3446 getRawFd(path: string, callback: _AsyncCallback<RawFileDescriptor>): void; 3447 3448 /** 3449 * Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode. 3450 * 3451 * @param { string } path - Indicates the resource relative path. 3452 * @returns { Promise<RawFileDescriptor> } The raw file resource descriptor corresponding to the specified resource path. 3453 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3454 * @throws { BusinessError } 9001005 - Invalid relative path. 3455 * @syscap SystemCapability.Global.ResourceManager 3456 * @since 9 3457 */ 3458 /** 3459 * Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode. 3460 * 3461 * @param { string } path - Indicates the resource relative path. 3462 * @returns { Promise<RawFileDescriptor> } The raw file resource descriptor corresponding to the specified resource path. 3463 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3464 * @throws { BusinessError } 9001005 - Invalid relative path. 3465 * @syscap SystemCapability.Global.ResourceManager 3466 * @crossplatform 3467 * @since 10 3468 */ 3469 /** 3470 * Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode. 3471 * 3472 * @param { string } path - Indicates the resource relative path. 3473 * @returns { Promise<RawFileDescriptor> } The raw file resource descriptor corresponding to the specified resource path. 3474 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3475 * @throws { BusinessError } 9001005 - Invalid relative path. 3476 * @syscap SystemCapability.Global.ResourceManager 3477 * @crossplatform 3478 * @atomicservice 3479 * @since 11 3480 */ 3481 getRawFd(path: string): Promise<RawFileDescriptor>; 3482 3483 /** 3484 * Obtains close raw file resource descriptor corresponding to the specified resource path in callback mode. 3485 * 3486 * @param { string } path - Indicates the resource relative path. 3487 * @param { _AsyncCallback<void> } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. 3488 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3489 * @throws { BusinessError } 9001005 - Invalid relative path. 3490 * @syscap SystemCapability.Global.ResourceManager 3491 * @since 9 3492 */ 3493 /** 3494 * Obtains close raw file resource descriptor corresponding to the specified resource path in callback mode. 3495 * 3496 * @param { string } path - Indicates the resource relative path. 3497 * @param { _AsyncCallback<void> } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. 3498 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3499 * @throws { BusinessError } 9001005 - Invalid relative path. 3500 * @syscap SystemCapability.Global.ResourceManager 3501 * @crossplatform 3502 * @since 10 3503 */ 3504 /** 3505 * Obtains close raw file resource descriptor corresponding to the specified resource path in callback mode. 3506 * 3507 * @param { string } path - Indicates the resource relative path. 3508 * @param { _AsyncCallback<void> } callback - Indicates the asynchronous callback used to return result close raw file resource descriptor. 3509 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3510 * @throws { BusinessError } 9001005 - Invalid relative path. 3511 * @syscap SystemCapability.Global.ResourceManager 3512 * @crossplatform 3513 * @atomicservice 3514 * @since 11 3515 */ 3516 closeRawFd(path: string, callback: _AsyncCallback<void>): void; 3517 3518 /** 3519 * Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode. 3520 * 3521 * @param { string } path - Indicates the resource relative path. 3522 * @returns { Promise<void> } The result close raw file resource descriptor corresponding to the specified resource path. 3523 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3524 * @throws { BusinessError } 9001005 - Invalid relative path. 3525 * @syscap SystemCapability.Global.ResourceManager 3526 * @since 9 3527 */ 3528 /** 3529 * Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode. 3530 * 3531 * @param { string } path - Indicates the resource relative path. 3532 * @returns { Promise<void> } The result close raw file resource descriptor corresponding to the specified resource path. 3533 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3534 * @throws { BusinessError } 9001005 - Invalid relative path. 3535 * @syscap SystemCapability.Global.ResourceManager 3536 * @crossplatform 3537 * @since 10 3538 */ 3539 /** 3540 * Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode. 3541 * 3542 * @param { string } path - Indicates the resource relative path. 3543 * @returns { Promise<void> } The result close raw file resource descriptor corresponding to the specified resource path. 3544 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3545 * @throws { BusinessError } 9001005 - Invalid relative path. 3546 * @syscap SystemCapability.Global.ResourceManager 3547 * @crossplatform 3548 * @atomicservice 3549 * @since 11 3550 */ 3551 closeRawFd(path: string): Promise<void>; 3552 3553 /** 3554 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource ID. 3555 * 3556 * @param { number } resId - Indicates the resource ID. 3557 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3558 * to use the density of current system dpi. 3559 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3560 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3561 * @throws { BusinessError } 9001001 - Invalid resource ID. 3562 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3563 * @syscap SystemCapability.Global.ResourceManager 3564 * @since 10 3565 */ 3566 /** 3567 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource ID. 3568 * 3569 * @param { number } resId - Indicates the resource ID. 3570 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3571 * to use the density of current system dpi. 3572 * @param { number } [type] - The optional parameter means the media type, the default value 0 means 3573 * the normal media. 3574 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3575 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3576 * @throws { BusinessError } 9001001 - Invalid resource ID. 3577 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3578 * @syscap SystemCapability.Global.ResourceManager 3579 * @atomicservice 3580 * @since 11 3581 */ 3582 /** 3583 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource ID. 3584 * 3585 * @param { number } resId - Indicates the resource ID. 3586 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3587 * to use the density of current system dpi. 3588 * @param { number } [type] - The optional parameter means the media type, the default value 0 means 3589 * the normal media. 3590 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3591 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3592 * @throws { BusinessError } 9001001 - Invalid resource ID. 3593 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3594 * @syscap SystemCapability.Global.ResourceManager 3595 * @crossplatform 3596 * @atomicservice 3597 * @since 12 3598 */ 3599 getDrawableDescriptor(resId: number, density?: number, type?: number): DrawableDescriptor; 3600 3601 /** 3602 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource Name. 3603 * 3604 * @param { string } resName - Indicates the resource name. 3605 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3606 * to use the density of current system dpi. 3607 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3608 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3609 * @throws { BusinessError } 9001003 - Invalid resource name. 3610 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3611 * @syscap SystemCapability.Global.ResourceManager 3612 * @since 10 3613 */ 3614 /** 3615 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource Name. 3616 * 3617 * @param { string } resName - Indicates the resource name. 3618 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3619 * to use the density of current system dpi. 3620 * @param { number } [type] - The optional parameter means the media type, the default value 0 means 3621 * the normal media. 3622 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3623 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3624 * @throws { BusinessError } 9001003 - Invalid resource name. 3625 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3626 * @syscap SystemCapability.Global.ResourceManager 3627 * @atomicservice 3628 * @since 11 3629 */ 3630 /** 3631 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource Name. 3632 * 3633 * @param { string } resName - Indicates the resource name. 3634 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3635 * to use the density of current system dpi. 3636 * @param { number } [type] - The optional parameter means the media type, the default value 0 means 3637 * the normal media. 3638 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3639 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3640 * @throws { BusinessError } 9001003 - Invalid resource name. 3641 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3642 * @syscap SystemCapability.Global.ResourceManager 3643 * @crossplatform 3644 * @atomicservice 3645 * @since 12 3646 */ 3647 getDrawableDescriptorByName(resName: string, density?: number, type?: number): DrawableDescriptor; 3648 3649 /** 3650 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource. 3651 * 3652 * @param { Resource } resource - Indicates the resource object. 3653 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3654 * to use the density of current system dpi. 3655 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3656 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3657 * @throws { BusinessError } 9001001 - Invalid resource ID. 3658 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3659 * @syscap SystemCapability.Global.ResourceManager 3660 * @stagemodelonly 3661 * @since 10 3662 */ 3663 /** 3664 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource. 3665 * 3666 * @param { Resource } resource - Indicates the resource object. 3667 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3668 * to use the density of current system dpi. 3669 * @param { number } [type] - The optional parameter means the media type, the default value 0 means 3670 * the normal media. 3671 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3672 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3673 * @throws { BusinessError } 9001001 - Invalid resource ID. 3674 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3675 * @syscap SystemCapability.Global.ResourceManager 3676 * @stagemodelonly 3677 * @atomicservice 3678 * @since 11 3679 */ 3680 /** 3681 * Obtains the DrawableDescriptor of the media file corresponding to a specified resource. 3682 * 3683 * @param { Resource } resource - Indicates the resource object. 3684 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 3685 * to use the density of current system dpi. 3686 * @param { number } [type] - The optional parameter means the media type, the default value 0 means 3687 * the normal media. 3688 * @returns { DrawableDescriptor } The DrawableDescriptor class to get drawable image. 3689 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 3690 * @throws { BusinessError } 9001001 - Invalid resource ID. 3691 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3692 * @syscap SystemCapability.Global.ResourceManager 3693 * @stagemodelonly 3694 * @crossplatform 3695 * @atomicservice 3696 * @since 12 3697 */ 3698 getDrawableDescriptor(resource: Resource, density?: number, type?: number): DrawableDescriptor; 3699 3700 /** 3701 * Obtains the rawfile resource list corresponding to the specified resource path in callback mode. 3702 * 3703 * @param { string } path - Indicates the resource relative path. 3704 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the raw file list. 3705 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3706 * @throws { BusinessError } 9001005 - Invalid relative path. 3707 * @syscap SystemCapability.Global.ResourceManager 3708 * @since 10 3709 */ 3710 /** 3711 * Obtains the rawfile resource list corresponding to the specified resource path in callback mode. 3712 * 3713 * @param { string } path - Indicates the resource relative path. 3714 * @param { _AsyncCallback<Array<string>> } callback - Indicates the asynchronous callback used to return the raw file list. 3715 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3716 * @throws { BusinessError } 9001005 - Invalid relative path. 3717 * @syscap SystemCapability.Global.ResourceManager 3718 * @crossplatform 3719 * @atomicservice 3720 * @since 11 3721 */ 3722 getRawFileList(path: string, callback: _AsyncCallback<Array<string>>): void; 3723 3724 /** 3725 * Obtains the rawfile resource list corresponding to the specified resource path in Promise mode. 3726 * 3727 * @param { string } path - Indicates the resource relative path. 3728 * @returns { Promise<Array<string>> } The rawfile list corresponding to the specified resource path. 3729 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3730 * @throws { BusinessError } 9001005 - Invalid relative path. 3731 * @syscap SystemCapability.Global.ResourceManager 3732 * @since 10 3733 */ 3734 /** 3735 * Obtains the rawfile resource list corresponding to the specified resource path in Promise mode. 3736 * 3737 * @param { string } path - Indicates the resource relative path. 3738 * @returns { Promise<Array<string>> } The rawfile list corresponding to the specified resource path. 3739 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3740 * @throws { BusinessError } 9001005 - Invalid relative path. 3741 * @syscap SystemCapability.Global.ResourceManager 3742 * @crossplatform 3743 * @atomicservice 3744 * @since 11 3745 */ 3746 getRawFileList(path: string): Promise<Array<string>>; 3747 3748 /** 3749 * Obtains the color resource corresponding to the specified resource ID in callback mode. 3750 * 3751 * @param { number } resId - Indicates the resource ID. 3752 * @param { _AsyncCallback<number> } callback - Indicates the asynchronous callback used to 3753 * return the integer reference value representing the color data. 3754 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3755 * @throws { BusinessError } 9001001 - Invalid resource ID. 3756 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3757 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3758 * @syscap SystemCapability.Global.ResourceManager 3759 * @since 10 3760 */ 3761 /** 3762 * Obtains the color resource corresponding to the specified resource ID in callback mode. 3763 * 3764 * @param { number } resId - Indicates the resource ID. 3765 * @param { _AsyncCallback<number> } callback - Indicates the asynchronous callback used to 3766 * return the integer reference value representing the color data. 3767 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3768 * @throws { BusinessError } 9001001 - Invalid resource ID. 3769 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3770 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3771 * @syscap SystemCapability.Global.ResourceManager 3772 * @crossplatform 3773 * @atomicservice 3774 * @since 11 3775 */ 3776 getColor(resId: number, callback: _AsyncCallback<number>): void; 3777 3778 /** 3779 * Obtains the color resource corresponding to the specified resource ID in promise mode. 3780 * 3781 * @param { number } resId - Indicates the resource ID. 3782 * @returns { Promise<number> } Indicates return the integer reference value representing the color data. 3783 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3784 * @throws { BusinessError } 9001001 - Invalid resource ID. 3785 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3786 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3787 * @syscap SystemCapability.Global.ResourceManager 3788 * @since 10 3789 */ 3790 /** 3791 * Obtains the color resource corresponding to the specified resource ID in promise mode. 3792 * 3793 * @param { number } resId - Indicates the resource ID. 3794 * @returns { Promise<number> } Indicates return the integer reference value representing the color data. 3795 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3796 * @throws { BusinessError } 9001001 - Invalid resource ID. 3797 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3798 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3799 * @syscap SystemCapability.Global.ResourceManager 3800 * @crossplatform 3801 * @atomicservice 3802 * @since 11 3803 */ 3804 getColor(resId: number): Promise<number>; 3805 3806 /** 3807 * Obtains the color resource corresponding to the specified resource object in callback mode. 3808 * 3809 * @param { Resource } resource - Indicates the resource object. 3810 * @param { _AsyncCallback<number> } callback - Indicates the asynchronous callback used to 3811 * return the integer reference value representing the color data. 3812 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3813 * @throws { BusinessError } 9001001 - Invalid resource ID. 3814 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3815 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3816 * @syscap SystemCapability.Global.ResourceManager 3817 * @stagemodelonly 3818 * @since 10 3819 */ 3820 /** 3821 * Obtains the color resource corresponding to the specified resource object in callback mode. 3822 * 3823 * @param { Resource } resource - Indicates the resource object. 3824 * @param { _AsyncCallback<number> } callback - Indicates the asynchronous callback used to 3825 * return the integer reference value representing the color data. 3826 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3827 * @throws { BusinessError } 9001001 - Invalid resource ID. 3828 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3829 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3830 * @syscap SystemCapability.Global.ResourceManager 3831 * @stagemodelonly 3832 * @crossplatform 3833 * @atomicservice 3834 * @since 11 3835 */ 3836 getColor(resource: Resource, callback: _AsyncCallback<number>): void; 3837 3838 /** 3839 * Obtains the color resource corresponding to the specified resource object in promise mode. 3840 * 3841 * @param { Resource } resource - Indicates the resource object. 3842 * @returns { Promise<number> } Indicates return the integer reference value representing the color data. 3843 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3844 * @throws { BusinessError } 9001001 - Invalid resource ID. 3845 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3846 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3847 * @syscap SystemCapability.Global.ResourceManager 3848 * @stagemodelonly 3849 * @since 10 3850 */ 3851 /** 3852 * Obtains the color resource corresponding to the specified resource object in promise mode. 3853 * 3854 * @param { Resource } resource - Indicates the resource object. 3855 * @returns { Promise<number> } Indicates return the integer reference value representing the color data. 3856 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3857 * @throws { BusinessError } 9001001 - Invalid resource ID. 3858 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3859 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3860 * @syscap SystemCapability.Global.ResourceManager 3861 * @stagemodelonly 3862 * @crossplatform 3863 * @atomicservice 3864 * @since 11 3865 */ 3866 getColor(resource: Resource): Promise<number>; 3867 3868 /** 3869 * Obtains the color resource corresponding to the specified resource object in callback mode. 3870 * 3871 * @param { string } resName - Indicates the resource name. 3872 * @param { _AsyncCallback<number> } callback - Indicates the asynchronous callback used to 3873 * return the integer reference value representing the color data. 3874 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3875 * @throws { BusinessError } 9001003 - Invalid resource name. 3876 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3877 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3878 * @syscap SystemCapability.Global.ResourceManager 3879 * @since 10 3880 */ 3881 /** 3882 * Obtains the color resource corresponding to the specified resource object in callback mode. 3883 * 3884 * @param { string } resName - Indicates the resource name. 3885 * @param { _AsyncCallback<number> } callback - Indicates the asynchronous callback used to 3886 * return the integer reference value representing the color data. 3887 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3888 * @throws { BusinessError } 9001003 - Invalid resource name. 3889 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3890 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3891 * @syscap SystemCapability.Global.ResourceManager 3892 * @crossplatform 3893 * @atomicservice 3894 * @since 11 3895 */ 3896 getColorByName(resName: string, callback: _AsyncCallback<number>): void; 3897 3898 /** 3899 * Obtains the color resource corresponding to the specified resource object in promise mode. 3900 * 3901 * @param { string } resName - Indicates the resource name. 3902 * @returns { Promise<number> } Indicates return the integer reference value representing the color data. 3903 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3904 * @throws { BusinessError } 9001003 - Invalid resource name. 3905 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3906 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3907 * @syscap SystemCapability.Global.ResourceManager 3908 * @since 10 3909 */ 3910 /** 3911 * Obtains the color resource corresponding to the specified resource object in promise mode. 3912 * 3913 * @param { string } resName - Indicates the resource name. 3914 * @returns { Promise<number> } Indicates return the integer reference value representing the color data. 3915 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3916 * @throws { BusinessError } 9001003 - Invalid resource name. 3917 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3918 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3919 * @syscap SystemCapability.Global.ResourceManager 3920 * @crossplatform 3921 * @atomicservice 3922 * @since 11 3923 */ 3924 getColorByName(resName: string): Promise<number>; 3925 3926 /** 3927 * Obtains the color resource corresponding to the specified resource ID. 3928 * 3929 * @param { number } resId - Indicates the resource ID. 3930 * @returns { number } Indicates the integer reference value representing the color data. 3931 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3932 * @throws { BusinessError } 9001001 - Invalid resource ID. 3933 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3934 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3935 * @syscap SystemCapability.Global.ResourceManager 3936 * @since 10 3937 */ 3938 /** 3939 * Obtains the color resource corresponding to the specified resource ID. 3940 * 3941 * @param { number } resId - Indicates the resource ID. 3942 * @returns { number } Indicates the integer reference value representing the color data. 3943 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3944 * @throws { BusinessError } 9001001 - Invalid resource ID. 3945 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3946 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3947 * @syscap SystemCapability.Global.ResourceManager 3948 * @crossplatform 3949 * @atomicservice 3950 * @since 11 3951 */ 3952 getColorSync(resId: number) : number; 3953 3954 /** 3955 * Obtains the color resource corresponding to the specified resource object. 3956 * 3957 * @param { Resource } resource - Indicates the resource object. 3958 * @returns { number } Indicates the integer reference value representing the color data. 3959 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3960 * @throws { BusinessError } 9001001 - Invalid resource ID. 3961 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3962 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3963 * @syscap SystemCapability.Global.ResourceManager 3964 * @stagemodelonly 3965 * @since 10 3966 */ 3967 /** 3968 * Obtains the color resource corresponding to the specified resource object. 3969 * 3970 * @param { Resource } resource - Indicates the resource object. 3971 * @returns { number } Indicates the integer reference value representing the color data. 3972 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3973 * @throws { BusinessError } 9001001 - Invalid resource ID. 3974 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 3975 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3976 * @syscap SystemCapability.Global.ResourceManager 3977 * @stagemodelonly 3978 * @crossplatform 3979 * @atomicservice 3980 * @since 11 3981 */ 3982 getColorSync(resource: Resource) : number; 3983 3984 /** 3985 * Obtains the color resource corresponding to the specified resource name. 3986 * 3987 * @param { string } resName - Indicates the resource name. 3988 * @returns { number } Indicates the integer reference value representing the color data. 3989 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 3990 * @throws { BusinessError } 9001003 - Invalid resource name. 3991 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 3992 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 3993 * @syscap SystemCapability.Global.ResourceManager 3994 * @since 10 3995 */ 3996 /** 3997 * Obtains the color resource corresponding to the specified resource name. 3998 * 3999 * @param { string } resName - Indicates the resource name. 4000 * @returns { number } Indicates the integer reference value representing the color data. 4001 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4002 * @throws { BusinessError } 9001003 - Invalid resource name. 4003 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4004 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4005 * @syscap SystemCapability.Global.ResourceManager 4006 * @crossplatform 4007 * @atomicservice 4008 * @since 11 4009 */ 4010 getColorByNameSync(resName: string) : number; 4011 4012 /** 4013 * Add overlay resources during application runtime. 4014 * 4015 * @param { string } path - Indicates the application overlay path. 4016 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4017 * @throws { BusinessError } 9001010 - Invalid overlay path. 4018 * @syscap SystemCapability.Global.ResourceManager 4019 * @since 10 4020 */ 4021 /** 4022 * Add overlay resources during application runtime. 4023 * 4024 * @param { string } path - Indicates the application overlay path. 4025 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4026 * @throws { BusinessError } 9001010 - Invalid overlay path. 4027 * @syscap SystemCapability.Global.ResourceManager 4028 * @crossplatform 4029 * @atomicservice 4030 * @since 11 4031 */ 4032 addResource(path: string) : void; 4033 4034 /** 4035 * Remove overlay resources during application runtime. 4036 * 4037 * @param { string } path - Indicates the application overlay path. 4038 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4039 * @throws { BusinessError } 9001010 - Invalid overlay path. 4040 * @syscap SystemCapability.Global.ResourceManager 4041 * @since 10 4042 */ 4043 /** 4044 * Remove overlay resources during application runtime. 4045 * 4046 * @param { string } path - Indicates the application overlay path. 4047 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4048 * @throws { BusinessError } 9001010 - Invalid overlay path. 4049 * @syscap SystemCapability.Global.ResourceManager 4050 * @crossplatform 4051 * @atomicservice 4052 * @since 11 4053 */ 4054 removeResource(path: string) : void; 4055 4056 /** 4057 * Obtains the raw file resource descriptor corresponding to the specified resource path. 4058 * 4059 * @param { string } path - Indicates the resource relative path. 4060 * @returns { RawFileDescriptor } The raw file resource descriptor. 4061 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4062 * @throws { BusinessError } 9001005 - Invalid relative path. 4063 * @syscap SystemCapability.Global.ResourceManager 4064 * @since 10 4065 */ 4066 /** 4067 * Obtains the raw file resource descriptor corresponding to the specified resource path. 4068 * 4069 * @param { string } path - Indicates the resource relative path. 4070 * @returns { RawFileDescriptor } The raw file resource descriptor. 4071 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4072 * @throws { BusinessError } 9001005 - Invalid relative path. 4073 * @syscap SystemCapability.Global.ResourceManager 4074 * @crossplatform 4075 * @atomicservice 4076 * @since 11 4077 */ 4078 getRawFdSync(path: string): RawFileDescriptor; 4079 4080 /** 4081 * Close the raw file resource descriptor corresponding to the specified resource path. 4082 * 4083 * @param { string } path - Indicates the resource relative path. 4084 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4085 * @throws { BusinessError } 9001005 - Invalid relative path. 4086 * @syscap SystemCapability.Global.ResourceManager 4087 * @since 10 4088 */ 4089 /** 4090 * Close the raw file resource descriptor corresponding to the specified resource path. 4091 * 4092 * @param { string } path - Indicates the resource relative path. 4093 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4094 * @throws { BusinessError } 9001005 - Invalid relative path. 4095 * @syscap SystemCapability.Global.ResourceManager 4096 * @crossplatform 4097 * @atomicservice 4098 * @since 11 4099 */ 4100 closeRawFdSync(path: string): void; 4101 4102 /** 4103 * Obtains the rawfile resource list corresponding to the specified resource path. 4104 * 4105 * @param { string } path - Indicates the resource relative path. 4106 * @returns { Array<string> } The rawfile resource list. 4107 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4108 * @throws { BusinessError } 9001005 - Invalid relative path. 4109 * @syscap SystemCapability.Global.ResourceManager 4110 * @since 10 4111 */ 4112 /** 4113 * Obtains the rawfile resource list corresponding to the specified resource path. 4114 * 4115 * @param { string } path - Indicates the resource relative path. 4116 * @returns { Array<string> } The rawfile resource list. 4117 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4118 * @throws { BusinessError } 9001005 - Invalid relative path. 4119 * @syscap SystemCapability.Global.ResourceManager 4120 * @crossplatform 4121 * @atomicservice 4122 * @since 11 4123 */ 4124 getRawFileListSync(path: string): Array<string>; 4125 4126 /** 4127 * Obtains the raw file resource corresponding to the specified resource path. 4128 * 4129 * @param { string } path - Indicates the resource relative path. 4130 * @returns { Uint8Array } the raw file resource corresponding to the specified resource path. 4131 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4132 * @throws { BusinessError } 9001005 - Invalid relative path. 4133 * @syscap SystemCapability.Global.ResourceManager 4134 * @since 10 4135 */ 4136 /** 4137 * Obtains the raw file resource corresponding to the specified resource path. 4138 * 4139 * @param { string } path - Indicates the resource relative path. 4140 * @returns { Uint8Array } the raw file resource corresponding to the specified resource path. 4141 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4142 * @throws { BusinessError } 9001005 - Invalid relative path. 4143 * @syscap SystemCapability.Global.ResourceManager 4144 * @crossplatform 4145 * @atomicservice 4146 * @since 11 4147 */ 4148 getRawFileContentSync(path: string): Uint8Array; 4149 4150 /** 4151 * Obtains the content of the specified screen density media file corresponding to a specified resource ID. 4152 * 4153 * @param { number } resId - Indicates the resource ID. 4154 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4155 * to use the density of current system dpi. 4156 * @returns { Uint8Array } Indicates the obtained media file content. 4157 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4158 * @throws { BusinessError } 9001001 - Invalid resource ID. 4159 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4160 * @syscap SystemCapability.Global.ResourceManager 4161 * @since 10 4162 */ 4163 /** 4164 * Obtains the content of the specified screen density media file corresponding to a specified resource ID. 4165 * 4166 * @param { number } resId - Indicates the resource ID. 4167 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4168 * to use the density of current system dpi. 4169 * @returns { Uint8Array } Indicates the obtained media file content. 4170 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4171 * @throws { BusinessError } 9001001 - Invalid resource ID. 4172 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4173 * @syscap SystemCapability.Global.ResourceManager 4174 * @crossplatform 4175 * @atomicservice 4176 * @since 11 4177 */ 4178 getMediaContentSync(resId: number, density?: number): Uint8Array; 4179 4180 /** 4181 * Obtains the content of the specified screen density media file corresponding to a specified resource object. 4182 * 4183 * @param { Resource } resource - Indicates the resource object. 4184 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4185 * to use the density of current system dpi. 4186 * @returns { Uint8Array } Indicates the obtained media file content. 4187 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4188 * @throws { BusinessError } 9001001 - Invalid resource ID. 4189 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4190 * @syscap SystemCapability.Global.ResourceManager 4191 * @stagemodelonly 4192 * @since 10 4193 */ 4194 /** 4195 * Obtains the content of the specified screen density media file corresponding to a specified resource object. 4196 * 4197 * @param { Resource } resource - Indicates the resource object. 4198 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4199 * to use the density of current system dpi. 4200 * @returns { Uint8Array } Indicates the obtained media file content. 4201 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4202 * @throws { BusinessError } 9001001 - Invalid resource ID. 4203 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4204 * @syscap SystemCapability.Global.ResourceManager 4205 * @stagemodelonly 4206 * @crossplatform 4207 * @atomicservice 4208 * @since 11 4209 */ 4210 getMediaContentSync(resource: Resource, density?: number): Uint8Array; 4211 4212 /** 4213 * Obtains the Base64 code of the specified screen density media file corresponding to the specified resource ID. 4214 * 4215 * @param { number } resId - Indicates the resource ID. 4216 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4217 * to use the density of current system dpi. 4218 * @returns { string } Indicates the obtained Base64 code of the media file. 4219 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4220 * @throws { BusinessError } 9001001 - Invalid resource ID. 4221 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4222 * @syscap SystemCapability.Global.ResourceManager 4223 * @since 10 4224 */ 4225 /** 4226 * Obtains the Base64 code of the specified screen density media file corresponding to the specified resource ID. 4227 * 4228 * @param { number } resId - Indicates the resource ID. 4229 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4230 * to use the density of current system dpi. 4231 * @returns { string } Indicates the obtained Base64 code of the media file. 4232 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4233 * @throws { BusinessError } 9001001 - Invalid resource ID. 4234 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4235 * @syscap SystemCapability.Global.ResourceManager 4236 * @crossplatform 4237 * @atomicservice 4238 * @since 11 4239 */ 4240 getMediaContentBase64Sync(resId: number, density?: number): string; 4241 4242 /** 4243 * Obtains the content of the specified screen density media file corresponding to the specified resource object. 4244 * 4245 * @param { Resource } resource - Indicates the resource object. 4246 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4247 * to use the density of current system dpi. 4248 * @returns { string } Indicates the obtained Base64 code of the media file. 4249 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4250 * @throws { BusinessError } 9001001 - Invalid resource ID. 4251 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4252 * @syscap SystemCapability.Global.ResourceManager 4253 * @stagemodelonly 4254 * @since 10 4255 */ 4256 /** 4257 * Obtains the content of the specified screen density media file corresponding to the specified resource object. 4258 * 4259 * @param { Resource } resource - Indicates the resource object. 4260 * @param { number } [density] - The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4261 * to use the density of current system dpi. 4262 * @returns { string } Indicates the obtained Base64 code of the media file. 4263 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4264 * @throws { BusinessError } 9001001 - Invalid resource ID. 4265 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4266 * @syscap SystemCapability.Global.ResourceManager 4267 * @stagemodelonly 4268 * @crossplatform 4269 * @atomicservice 4270 * @since 11 4271 */ 4272 getMediaContentBase64Sync(resource: Resource, density?: number): string; 4273 4274 /** 4275 * Obtains the singular-plural character string represented by the ID string corresponding to 4276 * the specified number. 4277 * 4278 * @param { number } resId - Indicates the resource ID. 4279 * @param { number } num - Indicates the number. 4280 * @returns { string } The singular-plural character string represented by the ID string 4281 * corresponding to the specified number. 4282 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4283 * @throws { BusinessError } 9001001 - Invalid resource ID. 4284 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4285 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4286 * @syscap SystemCapability.Global.ResourceManager 4287 * @since 10 4288 */ 4289 /** 4290 * Obtains the singular-plural character string represented by the ID string corresponding to 4291 * the specified number. 4292 * 4293 * @param { number } resId - Indicates the resource ID. 4294 * @param { number } num - Indicates the number. 4295 * @returns { string } The singular-plural character string represented by the ID string 4296 * corresponding to the specified number. 4297 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4298 * @throws { BusinessError } 9001001 - Invalid resource ID. 4299 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4300 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4301 * @syscap SystemCapability.Global.ResourceManager 4302 * @crossplatform 4303 * @atomicservice 4304 * @since 11 4305 */ 4306 getPluralStringValueSync(resId: number, num: number): string; 4307 4308 /** 4309 * Obtains the singular-plural character string represented by the resource object string corresponding to the 4310 * specified number. 4311 * 4312 * @param { Resource } resource - Indicates the resource object. 4313 * @param { number } num - Indicates the number. 4314 * @returns { string } The singular-plural character string represented by the ID string 4315 * corresponding to the specified number. 4316 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4317 * @throws { BusinessError } 9001001 - Invalid resource ID. 4318 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4319 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4320 * @syscap SystemCapability.Global.ResourceManager 4321 * @stagemodelonly 4322 * @since 10 4323 */ 4324 /** 4325 * Obtains the singular-plural character string represented by the resource object string corresponding to the 4326 * specified number. 4327 * 4328 * @param { Resource } resource - Indicates the resource object. 4329 * @param { number } num - Indicates the number. 4330 * @returns { string } The singular-plural character string represented by the ID string 4331 * corresponding to the specified number. 4332 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4333 * @throws { BusinessError } 9001001 - Invalid resource ID. 4334 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4335 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4336 * @syscap SystemCapability.Global.ResourceManager 4337 * @stagemodelonly 4338 * @crossplatform 4339 * @atomicservice 4340 * @since 11 4341 */ 4342 getPluralStringValueSync(resource: Resource, num: number): string; 4343 4344 /** 4345 * Obtains the array of character strings corresponding to a specified resource ID. 4346 * 4347 * @param { number } resId - Indicates the resource ID. 4348 * @returns { Array<string> } The array of character strings corresponding to the specified resource ID. 4349 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4350 * @throws { BusinessError } 9001001 - Invalid resource ID. 4351 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4352 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4353 * @syscap SystemCapability.Global.ResourceManager 4354 * @since 10 4355 */ 4356 /** 4357 * Obtains the array of character strings corresponding to a specified resource ID. 4358 * 4359 * @param { number } resId - Indicates the resource ID. 4360 * @returns { Array<string> } The array of character strings corresponding to the specified resource ID. 4361 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4362 * @throws { BusinessError } 9001001 - Invalid resource ID. 4363 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4364 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4365 * @syscap SystemCapability.Global.ResourceManager 4366 * @crossplatform 4367 * @atomicservice 4368 * @since 11 4369 */ 4370 getStringArrayValueSync(resId: number): Array<string>; 4371 4372 /** 4373 * Obtains the array of character strings corresponding to a specified resource object. 4374 * 4375 * @param { Resource } resource - Indicates the resource object. 4376 * @returns { Array<string> } The array of character strings corresponding to the specified resource object. 4377 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4378 * @throws { BusinessError } 9001001 - Invalid resource ID. 4379 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4380 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4381 * @syscap SystemCapability.Global.ResourceManager 4382 * @stagemodelonly 4383 * @since 10 4384 */ 4385 /** 4386 * Obtains the array of character strings corresponding to a specified resource object. 4387 * 4388 * @param { Resource } resource - Indicates the resource object. 4389 * @returns { Array<string> } The array of character strings corresponding to the specified resource object. 4390 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4391 * @throws { BusinessError } 9001001 - Invalid resource ID. 4392 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4393 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4394 * @syscap SystemCapability.Global.ResourceManager 4395 * @stagemodelonly 4396 * @crossplatform 4397 * @atomicservice 4398 * @since 11 4399 */ 4400 getStringArrayValueSync(resource: Resource): Array<string>; 4401 4402 /** 4403 * Obtains the singular-plural character string represented by the name string corresponding to 4404 * the specified number. 4405 * 4406 * @param { string } resName - Indicates the resource name. 4407 * @param { number } num - Indicates the number. 4408 * @returns { string } The singular-plural character string represented by the name string 4409 * corresponding to the specified number. 4410 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4411 * @throws { BusinessError } 9001003 - Invalid resource name. 4412 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4413 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4414 * @syscap SystemCapability.Global.ResourceManager 4415 * @since 10 4416 */ 4417 /** 4418 * Obtains the singular-plural character string represented by the name string corresponding to 4419 * the specified number. 4420 * 4421 * @param { string } resName - Indicates the resource name. 4422 * @param { number } num - Indicates the number. 4423 * @returns { string } The singular-plural character string represented by the name string 4424 * corresponding to the specified number. 4425 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4426 * @throws { BusinessError } 9001003 - Invalid resource name. 4427 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4428 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4429 * @syscap SystemCapability.Global.ResourceManager 4430 * @crossplatform 4431 * @atomicservice 4432 * @since 11 4433 */ 4434 getPluralStringByNameSync(resName: string, num: number): string; 4435 4436 /** 4437 * Obtains the content of the specified screen density media file corresponding to a specified resource name. 4438 * 4439 * @param { string } resName - Indicates the resource name. 4440 * @param { number } [density] - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4441 * to use the density of current system dpi. 4442 * @returns { Uint8Array } The obtained specified screen density media file content. 4443 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4444 * @throws { BusinessError } 9001003 - Invalid resource name. 4445 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4446 * @syscap SystemCapability.Global.ResourceManager 4447 * @since 10 4448 */ 4449 /** 4450 * Obtains the content of the specified screen density media file corresponding to a specified resource name. 4451 * 4452 * @param { string } resName - Indicates the resource name. 4453 * @param { number } [density] - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4454 * to use the density of current system dpi. 4455 * @returns { Uint8Array } The obtained specified screen density media file content. 4456 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4457 * @throws { BusinessError } 9001003 - Invalid resource name. 4458 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4459 * @syscap SystemCapability.Global.ResourceManager 4460 * @crossplatform 4461 * @atomicservice 4462 * @since 11 4463 */ 4464 getMediaByNameSync(resName: string, density?: number): Uint8Array; 4465 4466 /** 4467 * Obtains the Base64 code of the specified screen density media file corresponding to the specified resource name. 4468 * 4469 * @param { string } resName - Indicates the resource name. 4470 * @param { number } [density] - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4471 * to use the density of current system dpi. 4472 * @returns { string } The obtained Base64 code of the specified screen density media file. 4473 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4474 * @throws { BusinessError } 9001003 - Invalid resource name. 4475 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4476 * @syscap SystemCapability.Global.ResourceManager 4477 * @since 10 4478 */ 4479 /** 4480 * Obtains the Base64 code of the specified screen density media file corresponding to the specified resource name. 4481 * 4482 * @param { string } resName - Indicates the resource name. 4483 * @param { number } [density] - The parameter ScreenDensity{@link ScreenDensity}, A value of 0 means 4484 * to use the density of current system dpi. 4485 * @returns { string } The obtained Base64 code of the specified screen density media file. 4486 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed. 4487 * @throws { BusinessError } 9001003 - Invalid resource name. 4488 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4489 * @syscap SystemCapability.Global.ResourceManager 4490 * @crossplatform 4491 * @atomicservice 4492 * @since 11 4493 */ 4494 getMediaBase64ByNameSync(resName: string, density?: number): string; 4495 4496 /** 4497 * Obtains the array of character strings corresponding to a specified resource name. 4498 * 4499 * @param { string } resName - Indicates the resource name. 4500 * @returns { Array<string> } the array of character strings corresponding to the specified resource name. 4501 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4502 * @throws { BusinessError } 9001003 - Invalid resource name. 4503 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4504 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4505 * @syscap SystemCapability.Global.ResourceManager 4506 * @since 10 4507 */ 4508 /** 4509 * Obtains the array of character strings corresponding to a specified resource name. 4510 * 4511 * @param { string } resName - Indicates the resource name. 4512 * @returns { Array<string> } the array of character strings corresponding to the specified resource name. 4513 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4514 * @throws { BusinessError } 9001003 - Invalid resource name. 4515 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4516 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4517 * @syscap SystemCapability.Global.ResourceManager 4518 * @crossplatform 4519 * @atomicservice 4520 * @since 11 4521 */ 4522 getStringArrayByNameSync(resName: string): Array<string>; 4523 4524 /** 4525 * Obtains the device configuration. 4526 * 4527 * @returns { Configuration } the device configuration. 4528 * @syscap SystemCapability.Global.ResourceManager 4529 * @since 10 4530 */ 4531 /** 4532 * Obtains the device configuration. 4533 * 4534 * @returns { Configuration } the device configuration. 4535 * @syscap SystemCapability.Global.ResourceManager 4536 * @crossplatform 4537 * @atomicservice 4538 * @since 11 4539 */ 4540 getConfigurationSync(): Configuration; 4541 4542 /** 4543 * Obtains the device capability. 4544 * 4545 * @returns { DeviceCapability } the device capability. 4546 * @syscap SystemCapability.Global.ResourceManager 4547 * @since 10 4548 */ 4549 /** 4550 * Obtains the device capability. 4551 * 4552 * @returns { DeviceCapability } the device capability. 4553 * @syscap SystemCapability.Global.ResourceManager 4554 * @crossplatform 4555 * @atomicservice 4556 * @since 11 4557 */ 4558 getDeviceCapabilitySync(): DeviceCapability; 4559 4560 /** 4561 * Obtains locales list. 4562 * 4563 * @param { boolean } [includeSystem] - the parameter controls whether to include system resources, 4564 * the default value is false, it has no effect when only system resources query the locales list. 4565 * @returns { Array<string> } the list of strings for the locales. 4566 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4567 * @syscap SystemCapability.Global.ResourceManager 4568 * @crossplatform 4569 * @atomicservice 4570 * @since 11 4571 */ 4572 getLocales(includeSystem?: boolean): Array<string>; 4573 4574 /** 4575 * Obtains the symbol resource corresponding to the specified resource ID. 4576 * 4577 * @param { number } resId - Indicates the resource ID. 4578 * @returns { number } Indicates the integer reference value representing the symbol data. 4579 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4580 * @throws { BusinessError } 9001001 - Invalid resource ID. 4581 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4582 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4583 * @syscap SystemCapability.Global.ResourceManager 4584 * @crossplatform 4585 * @atomicservice 4586 * @since 11 4587 */ 4588 getSymbol(resId: number) : number; 4589 4590 /** 4591 * Obtains the symbol resource corresponding to the specified resource object. 4592 * 4593 * @param { Resource } resource - Indicates the resource object. 4594 * @returns { number } Indicates the integer reference value representing the symbol data. 4595 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4596 * @throws { BusinessError } 9001001 - Invalid resource ID. 4597 * @throws { BusinessError } 9001002 - No matching resource is found based on the resource ID. 4598 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4599 * @syscap SystemCapability.Global.ResourceManager 4600 * @stagemodelonly 4601 * @crossplatform 4602 * @atomicservice 4603 * @since 11 4604 */ 4605 getSymbol(resource: Resource) : number; 4606 4607 /** 4608 * Obtains the symbol resource corresponding to the specified resource name. 4609 * 4610 * @param { string } resName - Indicates the resource name. 4611 * @returns { number } Indicates the integer reference value representing the symbol data. 4612 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4613 * @throws { BusinessError } 9001003 - Invalid resource name. 4614 * @throws { BusinessError } 9001004 - No matching resource is found based on the resource name. 4615 * @throws { BusinessError } 9001006 - The resource is referenced cyclically. 4616 * @syscap SystemCapability.Global.ResourceManager 4617 * @crossplatform 4618 * @atomicservice 4619 * @since 11 4620 */ 4621 getSymbolByName(resName: string) : number; 4622 4623 /** 4624 * Whether the rawfile resource is a directory or not. 4625 * 4626 * @param { string } path - Indicates the rawfile resource relative path. 4627 * @returns { boolean } True means the file path is directory, else false. 4628 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4629 * @throws { BusinessError } 9001005 - Invalid relative path. 4630 * @syscap SystemCapability.Global.ResourceManager 4631 * @crossplatform 4632 * @atomicservice 4633 * @since 12 4634 */ 4635 isRawDir(path: string): boolean; 4636 4637 /** 4638 * Get the override ResourceManager object related to the specified Configuration. 4639 * 4640 * @param { Configuration } [configuration] - Indicates the override Configuration{@link Configuration} 4641 * @returns { ResourceManager } The ResourceManager object is returned. 4642 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4643 * @syscap SystemCapability.Global.ResourceManager 4644 * @crossplatform 4645 * @atomicservice 4646 * @since 12 4647 */ 4648 getOverrideResourceManager(configuration?: Configuration): ResourceManager; 4649 4650 /** 4651 * Get the current override Configuration related to the specified override ResourceManager. 4652 * 4653 * @returns { Configuration } The Configuration object is returned. 4654 * @syscap SystemCapability.Global.ResourceManager 4655 * @crossplatform 4656 * @atomicservice 4657 * @since 12 4658 */ 4659 getOverrideConfiguration(): Configuration; 4660 4661 /** 4662 * Update the current override Configuration. 4663 * 4664 * @param { Configuration } configuration - Indicates the override Configuration{@link Configuration} 4665 * @throws { BusinessError } 401 - If the input parameter invalid. Possible causes: Incorrect parameter types. 4666 * @syscap SystemCapability.Global.ResourceManager 4667 * @crossplatform 4668 * @atomicservice 4669 * @since 12 4670 */ 4671 updateOverrideConfiguration(configuration: Configuration): void; 4672 } 4673 4674 /** 4675 * Contains rawFile descriptor information. 4676 * 4677 * @syscap SystemCapability.Global.ResourceManager 4678 * @since 9 4679 */ 4680 /** 4681 * Contains rawFile descriptor information. 4682 * 4683 * @syscap SystemCapability.Global.ResourceManager 4684 * @crossplatform 4685 * @since 10 4686 */ 4687 /** 4688 * Contains rawFile descriptor information. 4689 * 4690 * @typedef {_RawFileDescriptor} 4691 * @syscap SystemCapability.Global.ResourceManager 4692 * @crossplatform 4693 * @atomicservice 4694 * @since 11 4695 */ 4696 export type RawFileDescriptor = _RawFileDescriptor; 4697 4698 /** 4699 * Contains resource descriptor information. 4700 * 4701 * @syscap SystemCapability.Global.ResourceManager 4702 * @since 9 4703 */ 4704 /** 4705 * Contains resource descriptor information. 4706 * 4707 * @syscap SystemCapability.Global.ResourceManager 4708 * @crossplatform 4709 * @since 10 4710 */ 4711 /** 4712 * Contains resource descriptor information. 4713 * 4714 * @typedef {_Resource} 4715 * @syscap SystemCapability.Global.ResourceManager 4716 * @crossplatform 4717 * @atomicservice 4718 * @since 11 4719 */ 4720 export type Resource = _Resource; 4721} 4722export default resourceManager;