npm 包 ohmage-es6 使用教程

简介

ohmage-es6 是一个基于 ohmage API 的 JavaScript 库，主要用于简化数据获取和管理。ohmage-es6 在基于 Promise 的异步接口上提供了更易用的封装，同时也支持一些应用场景下的自动化机制。

安装

使用 npm 进行安装：

npm install ohmage-es6 --save

使用

在项目中引入 ohmage-es6：

import ohmage from 'ohmage-es6';

初始化

在使用 ohmage-es6 之前需要进行初始化：

ohmage.init({
    serverUrl: 'http://example.com/ohmage',
    user: 'username',
    password: 'password'
});

API

ohmage-es6 提供了以下接口：

ohmage.login()

登录 ohmage 平台，需要传入用户名和密码。如果登录成功，返回当前用户的 ID。

ohmage.login().then(userId => {
    console.log('用户ID：' + userId);
}).catch(error => {
    console.error(error);
});

ohmage.logout()

退出登录。

ohmage.logout().then(() => {
    console.log('退出成功！');
}).catch(error => {
    console.error(error);
});

ohmage.getSurvey(surveyId)

获取一个调查的元数据。需要传入调查 ID。

ohmage.getSurvey('survey-id').then(survey => {
    console.log(survey);
}).catch(error => {
    console.error(error);
});

ohmage.getSurveys()

获取所有调查的元数据。

ohmage.getSurveys().then(surveys => {
    console.log(surveys);
}).catch(error => {
    console.error(error);
});

ohmage.createCampaign(name, description)

创建一个调查任务。需要传入任务名称和描述。

ohmage.createCampaign('任务名称', '任务描述').then(campaignId => {
    console.log('任务ID：' + campaignId);
}).catch(error => {
    console.error(error);
});

ohmage.deleteCampaign(campaignId)

删除一个调查任务。需要传入任务 ID。

ohmage.deleteCampaign('campaign-id').then(() => {
    console.log('删除成功！');
}).catch(error => {
    console.error(error);
});

ohmage.getCampaign(campaignId)

获取一个调查任务。需要传入任务 ID。

ohmage.getCampaign('campaign-id').then(campaign => {
    console.log(campaign);
}).catch(error => {
    console.error(error);
});

ohmage.getCampaigns()

获取所有调查任务的元数据。

ohmage.getCampaigns().then(campaigns => {
    console.log(campaigns);
}).catch(error => {
    console.error(error);
});

示例

以下是一个简单的例子，演示如何使用 ohmage-es6 获取所有调查任务的元数据：

-- -------------------- ---- -------
------ ------ ---- -------------

-------------
    ---------- ----------------------------
    ----- -----------
    --------- ----------
---

---------------------- -- -
    ------ ----------------------
----------------- -- -
    -----------------------
    ------ ----------------
---------- -- -
    ----------------------
-------------- -- -
    ---------------------
---

总结

ohmage-es6 是一个非常方便的 ohmage API 封装库，可以简化开发过程中的数据获取和管理，让代码更加易读易写，同时也可以提高代码的复用性和可维护性。如果你使用 ohmage 平台进行开发，ohmage-es6 的使用应该是非常好的选择。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600559e981e8991b448d792c