# virsical-jssdk

> Virsical 3.0 JS SDK

Latest version **0.3.6** (published 2019-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install virsical-jssdk
pnpm add virsical-jssdk
yarn add virsical-jssdk
bun add virsical-jssdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.6 |
| Published | 2019-09-16 |
| First published | 2017-05-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 141.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joe |
| Maintainers | qiaolb |
| Keywords | Virsical |

## Links

- npm: https://www.npmjs.com/package/virsical-jssdk
- Repository: https://github.com/qiaolb/virsical.jssdk
- Homepage: https://github.com/qiaolb/virsical.jssdk#readme
- Issues: https://github.com/qiaolb/virsical.jssdk/issues
- npm.io page: https://npm.io/package/virsical-jssdk

## Recent versions

- 0.3.6 (latest) — 2019-09-16
- 0.3.5 — 2018-08-30
- 0.3.4 — 2018-08-13
- 0.3.3 — 2018-01-29
- 0.3.2 — 2018-01-18
- 0.3.1 — 2018-01-18
- 0.3.0 — 2018-01-18
- 0.2.2 — 2018-01-16
- 0.2.1 — 2018-01-16
- 0.2.0 — 2018-01-09
- 0.1.12 — 2017-12-25
- 0.1.11 — 2017-12-25
- 0.1.10 — 2017-07-28
- 0.1.9 — 2017-05-22
- 0.1.8 — 2017-05-20
- … 14 more at https://npm.io/package/virsical-jssdk/versions

## README

# Virsical 3.0 JS SDK

[![npm](https://img.shields.io/npm/v/virsical-jssdk.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/virsical-jssdk)
![license-mit](https://img.shields.io/badge/license-MIT-42cd00.svg)
## build
```npm
yarn webpack
```

## deploy
```npm
npm publish
```

## install
```npm
npm install virsical-jssdk --save
```
 
## 调用
```javascript
import virsical from 'virsical-jssdk';
```

## 概述
此JS-SDK是威思客移动办公门户提供给第三方H5应用开发者使用的，可帮助运行于威思客APP内的H5网页获得更多的高级特性。通过使用此JS-SDK，第三方H5应用开发者可快捷地在手机中使用统一认证、拍照、选图、语音、位置、扫一扫等原生手机系统的能力，以此可有效提升用户体验。

## Web API
```javascript
virsical.config({
    debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来。
    client_id: '', // 必填，第三方应用接入ID
    client_secret: // 必填，第三方应用接入秘钥
});
```

```javascript
virsical.login({
    success: function (res) {
	var info = res.info; // 返回用户信息json
	alert("Login success" + "-" + info);
    },
	fail: function (res) {
        var msg = res.msg; // 失败原因
	var code = res.code; //失败编码
    }
});
```


```javascript
virsical.captureQR({
	success: function (res) {
		alert("url:" + res.url);
	},
	fail: function (res) {
		var msg = res.msg; // 失败原因
		var code = res.code; //失败编码
		alert("fail" + "-" + msg + "-" + code);
}
});
```
## App API

* config 

   识别符：`vsk3browser://config`
   
   参数：`clientid、clientsecret、[debug]`

   callback: 
   	
	   configReady(),配置成功后调用
	   configError(msg, code),配置失败后调用。msg: 异常信息，code，异常代码。

* login

	callback:
	
		loginResult(result, json, cd, mg), 登录成功后回调。
			result: 0成功，否则失败。
			json: 成功返回的数据。
			cd：状态码。
			mg：成功或失败的信息。
* 扫描二维码

	识别符：`vsk3browser://captureqr`

	callback:
		
		captureQRResult(result, url, cd, mg)
			result: 0 成功，否则失败。
			url: 扫描成功后回传的url.
			cd: 扫描失败的code
			mg: 扫描失败的message

---
_Source: https://npm.io/package/virsical-jssdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._