資源管理

資源管理模塊，根據(jù)當(dāng)前configuration（語(yǔ)言，區(qū)域，橫豎屏，mccmnc）和device capability（設(shè)備類型，分辨率）提供獲取應(yīng)用資源信息讀取接口。

說(shuō)明： 本模塊首批接口從API version 6開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。 開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導(dǎo)入模塊

import resourceManager from '@ohos.resourceManager';

使用說(shuō)明

從API Version9開(kāi)始，Stage模型支持了通過(guò)context獲取resourceManager對(duì)象的方式，再調(diào)用其接口，無(wú)需再導(dǎo)入包。

this.context.resourceManager;

resourceManager.getResourceManager

getResourceManager(callback: AsyncCallback): void

獲取當(dāng)前應(yīng)用的資源管理對(duì)象，使用callback形式返回ResourceManager對(duì)象。

此接口僅可在FA模型下使用。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    if (error != null) {
        console.log("error is " + error);
        return; 
    }
    mgr.getString(0x1000000, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
});

resourceManager.getResourceManager

getResourceManager(bundleName: string, callback: AsyncCallback): void

獲取指定應(yīng)用的資源管理對(duì)象，使用callback形式返回ResourceManager對(duì)象。

此接口僅可在FA模型下使用。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager("com.example.myapplication", (error, mgr) = > {
});

resourceManager.getResourceManager

getResourceManager(): Promise

獲取當(dāng)前應(yīng)用的資源管理對(duì)象，使用Promise形式返回ResourceManager對(duì)象。

此接口僅可在FA模型下使用。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

返回值：

示例：

resourceManager.getResourceManager().then(mgr = > {
    mgr.getString(0x1000000, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
}).catch(error = > {
    console.log("error is " + error);
});

resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise

獲取指定應(yīng)用的資源管理對(duì)象，使用Promise形式返回ResourceManager對(duì)象。

此接口僅可在FA模型下使用。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager("com.example.myapplication").then(mgr = > {

}).catch(error = > {

});

Direction

用于表示設(shè)備屏幕方向。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Global.ResourceManager

DeviceType

用于表示當(dāng)前設(shè)備類型。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Global.ResourceManager

ScreenDensity

用于表示當(dāng)前設(shè)備屏幕密度。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Global.ResourceManager

Configuration

表示當(dāng)前設(shè)備的狀態(tài)。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Global.ResourceManager

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getConfiguration((error, value) = > {
        let direction = value.direction;
        let locale = value.locale;
    });
});

DeviceCapability

表示設(shè)備支持的能力。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Global.ResourceManager

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getDeviceCapability((error, value) = > {
        let screenDensity = value.screenDensity;
        let deviceType = value.deviceType;
    });
});

RawFileDescriptor8+

表示rawfile的descriptor信息。
系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Global.ResourceManager

ResourceManager

提供訪問(wèn)應(yīng)用資源的能力。

說(shuō)明：

• ResourceManager涉及到的方法，僅限基于TS擴(kuò)展的聲明式開(kāi)發(fā)范式使用。
• 資源文件在工程的resources目錄中定義，id可通過(guò)r(資源地址).id的方式獲取，例如r(資源地址).id的方式獲取，例如r('app.string.test').id。

getString

getString(resId: number, callback: AsyncCallback): void

用戶獲取指定資源ID對(duì)應(yīng)的字符串，使用callback形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getString($r('app.string.test').id, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
});

getString

getString(resId: number): Promise

用戶獲取指定資源ID對(duì)應(yīng)的字符串，使用Promise形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getString($r('app.string.test').id).then(value = > {
        let str = value;
    }).catch(error = > {
        console.log("getstring promise error is " + error);
    });
});

getStringArray

getStringArray(resId: number, callback: AsyncCallback>): void

用戶獲取指定資源ID對(duì)應(yīng)的字符串?dāng)?shù)組，使用callback形式返回字符串?dāng)?shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getStringArray($r('app.strarray.test').id, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let strArray = value;
        }
    });
});

getStringArray

getStringArray(resId: number): Promise>

用戶獲取指定資源ID對(duì)應(yīng)的字符串?dāng)?shù)組，使用Promise形式返回字符串?dāng)?shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
     mgr.getStringArray($r('app.strarray.test').id).then(value = > {
        let strArray = value;
    }).catch(error = > {
        console.log("getStringArray promise error is " + error);
    });
});

getMedia

getMedia(resId: number, callback: AsyncCallback): void

用戶獲取指定資源ID對(duì)應(yīng)的媒體文件內(nèi)容，使用callback形式返回字節(jié)數(shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getMedia($r('app.media.test').id, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
});

getMedia

getMedia(resId: number): Promise

用戶獲取指定資源ID對(duì)應(yīng)的媒體文件內(nèi)容，使用Promise形式返回字節(jié)數(shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getMedia($r('app.media.test').id).then(value = > {
        let media = value;
    }).catch(error = > {
        console.log("getMedia promise error is " + error);
    });
});

getMediaBase64

getMediaBase64(resId: number, callback: AsyncCallback): void

用戶獲取指定資源ID對(duì)應(yīng)的圖片資源Base64編碼，使用callback形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getMediaBase64($r('app.media.test').id, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
});

getMediaBase64

getMediaBase64(resId: number): Promise

用戶獲取指定資源ID對(duì)應(yīng)的圖片資源Base64編碼，使用Promise形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getMediaBase64($r('app.media.test').id).then(value = > {
        let media = value;
    }).catch(error = > {
        console.log("getMediaBase64 promise error is " + error);
    });
});

getConfiguration

getConfiguration(callback: AsyncCallback): void

用戶獲取設(shè)備的Configuration，使用callback形式返回Configuration對(duì)象。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getConfiguration((error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let direction = value.direction;
            let locale = value.locale;
        }
    });
});

getConfiguration

getConfiguration(): Promise

用戶獲取設(shè)備的Configuration，使用Promise形式返回Configuration對(duì)象。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getConfiguration().then(value = > {
        let direction = value.direction;
        let locale = value.locale;
    }).catch(error = > {
        console.log("getConfiguration promise error is " + error);
    });
});

getDeviceCapability

getDeviceCapability(callback: AsyncCallback): void

用戶獲取設(shè)備的DeviceCapability，使用callback形式返回DeviceCapability對(duì)象。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getDeviceCapability((error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let screenDensity = value.screenDensity;
            let deviceType = value.deviceType;
        }
    });
});

getDeviceCapability

getDeviceCapability(): Promise

用戶獲取設(shè)備的DeviceCapability，使用Promise形式返回DeviceCapability對(duì)象。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getDeviceCapability().then(value = > {
        let screenDensity = value.screenDensity;
        let deviceType = value.deviceType;
    }).catch(error = > {
        console.log("getDeviceCapability promise error is " + error);
    });
});

getPluralString

getPluralString(resId: number, num: number, callback: AsyncCallback): void

根據(jù)指定數(shù)量獲取指定ID字符串表示的單復(fù)數(shù)字符串，使用callback形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getPluralString($r("app.plural.test").id, 1, (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
});

getPluralString

getPluralString(resId: number, num: number): Promise

根據(jù)指定數(shù)量獲取對(duì)指定ID字符串表示的單復(fù)數(shù)字符串，使用Promise形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getPluralString($r("app.plural.test").id, 1).then(value = > {
        let str = value;
    }).catch(error = > {
        console.log("getPluralString promise error is " + error);
    });
});

getRawFile8+

getRawFile(path: string, callback: AsyncCallback): void

用戶獲取resources/rawfile目錄下對(duì)應(yīng)的rawfile文件內(nèi)容，使用callback形式返回字節(jié)數(shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getRawFile("test.xml", (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let rawFile = value;
        }
    });
});

getRawFile8+

getRawFile(path: string): Promise

用戶獲取resources/rawfile目錄下對(duì)應(yīng)的rawfile文件內(nèi)容，使用Promise形式返回字節(jié)數(shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getRawFile("test.xml").then(value = > {
        let rawFile = value;
    }).catch(error = > {
        console.log("getRawFile promise error is " + error);
    });
});

getRawFileDescriptor8+

getRawFileDescriptor(path: string, callback: AsyncCallback): void

用戶獲取resources/rawfile目錄下對(duì)應(yīng)rawfile文件的descriptor，使用callback形式返回。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getRawFileDescriptor("test.xml", (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let fd = value.fd;
            let offset = value.offset;
            let length = value.length;
        }
    });
});

getRawFileDescriptor8+

getRawFileDescriptor(path: string): Promise

用戶獲取resources/rawfile目錄下對(duì)應(yīng)rawfile文件的descriptor，使用Promise形式返回。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getRawFileDescriptor("test.xml").then(value = > {
        let fd = value.fd;
        let offset = value.offset;
        let length = value.length;
    }).catch(error = > {
        console.log("getRawFileDescriptor promise error is " + error);
    });
});

closeRawFileDescriptor8+

closeRawFileDescriptor(path: string, callback: AsyncCallback): void

用戶關(guān)閉resources/rawfile目錄下rawfile文件的descriptor，使用callback形式返回。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.closeRawFileDescriptor("test.xml", (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        }
    });
});

closeRawFileDescriptor8+

closeRawFileDescriptor(path: string): Promise

用戶關(guān)閉resources/rawfile目錄下rawfile文件的descriptor，使用Promise形式返回。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.closeRawFileDescriptor("test.xml").then(value = > {
        let result = value;
    }).catch(error = > {
        console.log("closeRawFileDescriptor promise error is " + error);
    });
});

release7+

release()

用戶釋放創(chuàng)建的resourceManager。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.release();
});

getStringByName9+

getStringByName(resName: string, callback: AsyncCallback): void

用戶獲取指定資源名稱對(duì)應(yīng)的字符串，使用callback形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getStringByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let string = value;
    }
});

getStringByName9+

getStringByName(resName: string): Promise

用戶獲取指定資源名稱對(duì)應(yīng)的字符串，使用Promise形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getStringByName("test").then(value = > {
    let string = value;
}).catch(error = > {
    console.log("getStringByName promise error is " + error);
});

getStringArrayByName9+

getStringArrayByName(resName: string, callback: AsyncCallback>): void

用戶獲取指定資源名稱對(duì)應(yīng)的字符串?dāng)?shù)組，使用callback形式返回字符串?dāng)?shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getStringArrayByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let strArray = value;
    }
});

getStringArrayByName9+

getStringArrayByName(resName: string): Promise>

用戶獲取指定資源名稱對(duì)應(yīng)的字符串?dāng)?shù)組，使用Promise形式返回字符串?dāng)?shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getStringArrayByName("test").then(value = > {
    let strArray = value;
}).catch(error = > {
    console.log("getStringArrayByName promise error is " + error);
});

getMediaByName9+

getMediaByName(resName: string, callback: AsyncCallback): void

用戶獲取指定資源ID對(duì)應(yīng)的媒體文件內(nèi)容，使用callback形式返回字節(jié)數(shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getMediaByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let media = value;
    }
});

getMediaByName9+

getMediaByName(resName: string): Promise

用戶獲取指定資源名稱對(duì)應(yīng)的媒體文件內(nèi)容，使用Promise形式返回字節(jié)數(shù)組。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getMediaByName("test").then(value = > {
    let media = value;
}).catch(error = > {
    console.log("getMediaByName promise error is " + error);
});

getMediaBase64ByName9+

getMediaBase64ByName(resName: string, callback: AsyncCallback): void

用戶獲取指定資源名稱對(duì)應(yīng)的圖片資源Base64編碼，使用callback形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getMediaBase64ByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let media = value;
    }
});

getMediaBase64ByName9+

getMediaBase64ByName(resName: string): Promise

用戶獲取指定資源名稱對(duì)應(yīng)的圖片資源Base64編碼，使用Promise形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getMediaByName("test").then(value = > {
    let media = value;
}).catch(error = > {
    console.log("getMediaBase64ByName promise error is " + error);
});

getPluralStringByName9+

getPluralStringByName(resName: string, num: number, callback: AsyncCallback): void

根據(jù)傳入的數(shù)量值，獲取資源名稱對(duì)應(yīng)的字符串資源，使用callback形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

示例：

resourceManager.getPluralStringByName("test", 1, (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let str = value;
    }
});

getPluralStringByName9+

getPluralStringByName(resName: string, num: number): Promise

根據(jù)傳入的數(shù)量值，獲取資源名稱對(duì)應(yīng)的字符串資源，使用Promise形式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getPluralStringByName("test", 1).then(value = > {
    let str = value;
}).catch(error = > {
    console.log("getPluralStringByName promise error is " + error);
});

getStringSync9+

getStringSync(resId: number): string

用戶獲取指定資源ID對(duì)應(yīng)的字符串，使用同步方式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getStringSync($r('app.string.test').id);

getStringByNameSync9+

getStringByNameSync(resName: string): string

用戶獲取指定資源名稱對(duì)應(yīng)的字符串，使用同步方式返回字符串。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getStringByNameSync("test");

getBoolean9+

getBoolean(resId: number): boolean

使用同步方式，返回獲取指定資源ID對(duì)應(yīng)的布爾結(jié)果。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getBoolean($r('app.boolean.boolean_test').id);

getBooleanByName9+

getBooleanByName(resName: string): boolean

使用同步方式，返回獲取指定資源名稱對(duì)應(yīng)的布爾結(jié)果

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getBooleanByName("boolean_test");

getNumber9+

getNumber(resId: number): number

用戶獲取指定資源ID對(duì)應(yīng)的integer數(shù)值或者float數(shù)值，使用同步方式返回資源對(duì)應(yīng)的數(shù)值。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getNumber($r('app.integer.integer_test').id);
resourceManager.getNumber($r('app.float.float_test').id);

getNumberByName9+

getNumberByName(resName: string): number

用戶獲取指定資源名稱對(duì)應(yīng)的integer數(shù)值或者float數(shù)值，使用同步方式資源對(duì)應(yīng)的數(shù)值。

系統(tǒng)能力 ：SystemCapability.Global.ResourceManager

參數(shù)：

返回值：

示例：

resourceManager.getNumberByName("integer_test");
resourceManager.getNumberByName("float_test");

審核編輯 黃宇