hello.js 技术文档

1. 安装指南

下载安装

• 下载 HelloJS 或 HelloJS (压缩版)。

使用 npm 安装

npm i hellojs

使用 Bower 安装

bower install hello

2. 项目使用说明

hello.js 是一个客户端 JavaScript SDK，用于通过 OAuth2（及 OAuth1 使用 oauth 代理）认证 web 服务并查询其 REST API。hello.js 规范了常见 API（如 Google 数据服务、Facebook 图谱和 Windows Live Connect）的路径和响应。它是模块化的，因此支持列表正在不断扩展。

3. 项目API使用文档

hello.init()

初始化环境，并添加应用程序凭证。

语法

hello.init({
  facebook: *id*,
  windows: *id*,
  google: *id*,
  ...
});

参数

• credentials: 对象，包含 key 和 value，例如 {facebook: '359288236870', windows: '000000004403AD10'}

示例

hello.init({
  facebook: '359288236870',
  windows: '000000004403AD10'
});

hello.login()

启动对指定网络的认证流程，或打开一个提示框让用户选择一个网络进行认证。

语法

hello.login([network], [options], [callback()])

参数

• network: 字符串，例如 'windows' 或 'facebook'
• options: 对象，包含登录选项，如 {display: 'popup', scope: 'email'}

示例

hello.login('windows', {display: 'popup', scope: 'email'});

4. 项目安装方式

下载

从 GitHub 下载源码，并将其放置在项目的相应目录中。

npm

使用 npm 安装：

npm i hellojs

Bower

使用 Bower 安装：

bower install hello