介绍
WorkPlus 是一个企业级应用平台，提供了许多好用的 API 和插件，该 npm 包为 WorkPlus 前端开发提供一些基础封装。
安装
使用 npm 进行安装：
npm install workplus --save
使用
首先，在页面添加以下代码：
<script src="//res.wx.qq.com/open/js/jweixin-1.0.0.js"></script> <script src="//open.workplus.io/workplus-sdk/js/workplus-1.1.2.min.js"></script>
然后在需要使用 WorkPlus 功能的地方，声明一个 WorkPlus 对象：
var workplus = new WorkPlus();
现在，你就可以调用 WorkPlus 的 API 了，例如：
// 获取当前用户信息
workplus.getUserInfo().then(function(userInfo) {
console.log('当前用户信息：', userInfo);
}).catch(function(err) {
console.log('获取用户信息失败：', err);
});API
以下是 WorkPlus 可用的 API，具体的参数和返回值可以参考官方文档。
- init()
- getUserInfo()
- getAppConfig()
- getConfig()
- setCurrentConfig()
- getOauthAccessToken()
- getAppToken()
- getLocationInfo()
- getNetworkStatus()
- openWindow()
- workplusShare()
- chooseImage()
- previewImage()
- downloadFile()
- uploadFile()
- getServerTime()
init()
初始化 SDK。
workplus.init(options);
示例：
workplus.init({
appKey: '****',
appSecret: '****'
}).catch(function() {
console.log('初始化失败！');
});getUserInfo()
获取当前用户信息。
workplus.getUserInfo();
示例：
workplus.getUserInfo().then(function(userInfo) {
console.log('当前用户信息：', userInfo);
}).catch(function(err) {
console.log('获取用户信息失败：', err);
});getAppConfig()
获取当前应用配置信息。
workplus.getAppConfig();
示例：
workplus.getAppConfig().then(function(appConfig) {
console.log('当前应用配置信息：', appConfig);
}).catch(function(err) {
console.log('获取应用配置信息失败：', err);
});getConfig()
获取当前配置信息。
workplus.getConfig(opts);
示例：
workplus.getConfig({
key: 'language'
}).then(function(configValue) {
console.log('当前语言配置：', configValue);
}).catch(function(err) {
console.log('获取配置信息失败：', err);
});setCurrentConfig()
设置当前配置信息。
workplus.setCurrentConfig(opts);
示例：
workplus.setCurrentConfig({
key: 'language',
value: 'en'
}).then(function() {
console.log('设置语言配置成功！');
}).catch(function(err) {
console.log('设置语言配置失败：', err);
});getOauthAccessToken()
获取当前用户的 OAuth 授权 token。
workplus.getOauthAccessToken();
示例：
workplus.getOauthAccessToken().then(function(token) {
console.log('当前用户的 OAuth 授权 token：', token);
}).catch(function(err) {
console.log('获取 OAuth 授权 token 失败：', err);
});getAppToken()
获取应用授权 token。
workplus.getAppToken();
示例：
workplus.getAppToken().then(function(token) {
console.log('当前应用授权 token：', token);
}).catch(function(err) {
console.log('获取应用授权 token 失败：', err);
});getLocationInfo()
获取当前定位信息。
workplus.getLocationInfo();
示例：
workplus.getLocationInfo().then(function(locationInfo) {
console.log('当前定位信息：', locationInfo);
}).catch(function(err) {
console.log('获取定位信息失败：', err);
});getNetworkStatus()
获取当前网络状态。
workplus.getNetworkStatus();
示例：
workplus.getNetworkStatus().then(function(status) {
console.log('当前网络状态：', status);
}).catch(function(err) {
console.log('获取网络状态失败：', err);
});openWindow()
打开新窗口。
workplus.openWindow(opts);
示例：
-- -------------------- ---- -------
---------------------
---- -------------------------
------ -----------
------ -
----- --
---- --
------ -------
------- ------
-
------------------ -
------------------------
---------------------- -
----------------------- -----
---workplusShare()
分享给用户。
workplus.workplusShare(opts);
示例：
-- -------------------- ---- ------- ------------------------ ----- ------- ------ ----------- ----- ----------- ----- ------------------------- ------- ------------------------------------- ------------------ - --------------------- ---------------------- - -------------------- ----- ---
chooseImage()
从相册选择图片。
workplus.chooseImage(opts);
示例：
workplus.chooseImage({
count: 1
}).then(function(images) {
console.log('选择的图片信息：', images);
}).catch(function(err) {
console.log('选择图片失败：', err);
});previewImage()
预览图片。
workplus.previewImage(opts);
示例：
workplus.previewImage({
urls: ['http://www.workplus.io/img/logo.png']
}).catch(function(err) {
console.log('预览图片失败：', err);
});downloadFile()
下载文件。
workplus.downloadFile(opts);
示例：
-- -------------------- ---- -------
-----------------------
---- ----------------------------------
-------- ----------------- -
---------------------- ---------
--
----- ------------- -
---------------------- -----
-
---uploadFile()
上传文件。
workplus.uploadFile(opts);
示例：
-- -------------------- ---- -------
---------------------
---- --------------------------------
--------- ----------------------------
-------- ---------------- -
---------------------- --------
--
----- ------------- -
---------------------- -----
-
---getServerTime()
获取服务器时间。
workplus.getServerTime();
示例：
workplus.getServerTime().then(function(serverTime) {
console.log('服务器时间：', serverTime);
}).catch(function(err) {
console.log('获取服务器时间失败：', err);
});总结
通过本篇文章，我们对 WorkPlus 的 npm 包进行了详细的介绍和使用教程。希望本篇文章能够帮助开发者更好地使用 WorkPlus 进行开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671188dd3466f61ffe743