简介
ohmage-es6 是一个基于 ohmage API 的 JavaScript 库,主要用于简化数据获取和管理。ohmage-es6 在基于 Promise 的异步接口上提供了更易用的封装,同时也支持一些应用场景下的自动化机制。
安装
使用 npm 进行安装:
--- ------- ---------- ------
使用
在项目中引入 ohmage-es6:
------ ------ ---- -------------
初始化
在使用 ohmage-es6 之前需要进行初始化:
------------- ---------- ---------------------------- ----- ----------- --------- ---------- ---
API
ohmage-es6 提供了以下接口:
ohmage.login()
登录 ohmage 平台,需要传入用户名和密码。如果登录成功,返回当前用户的 ID。
-------------------------- -- - ------------------- - -------- -------------- -- - --------------------- ---
ohmage.logout()
退出登录。
----------------------- -- - --------------------- -------------- -- - --------------------- ---
ohmage.getSurvey(surveyId)
获取一个调查的元数据。需要传入调查 ID。
----------------------------------------- -- - -------------------- -------------- -- - --------------------- ---
ohmage.getSurveys()
获取所有调查的元数据。
-------------------------------- -- - --------------------- -------------- -- - --------------------- ---
ohmage.createCampaign(name, description)
创建一个调查任务。需要传入任务名称和描述。
----------------------------- ----------------------- -- - ------------------- - ------------ -------------- -- - --------------------- ---
ohmage.deleteCampaign(campaignId)
删除一个调查任务。需要传入任务 ID。
-------------------------------------------- -- - --------------------- -------------- -- - --------------------- ---
ohmage.getCampaign(campaignId)
获取一个调查任务。需要传入任务 ID。
----------------------------------------------- -- - ---------------------- -------------- -- - --------------------- ---
ohmage.getCampaigns()
获取所有调查任务的元数据。
------------------------------------ -- - ----------------------- -------------- -- - --------------------- ---
示例
以下是一个简单的例子,演示如何使用 ohmage-es6 获取所有调查任务的元数据:
------ ------ ---- ------------- ------------- ---------- ---------------------------- ----- ----------- --------- ---------- --- ---------------------- -- - ------ ---------------------- ----------------- -- - ----------------------- ------ ---------------- ---------- -- - ---------------------- -------------- -- - --------------------- ---
总结
ohmage-es6 是一个非常方便的 ohmage API 封装库,可以简化开发过程中的数据获取和管理,让代码更加易读易写,同时也可以提高代码的复用性和可维护性。如果你使用 ohmage 平台进行开发,ohmage-es6 的使用应该是非常好的选择。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600559e981e8991b448d792c