# TXLicence

**Repository Path**: tyousan_admin/TXLicence

## Basic Information

- **Project Name**: TXLicence
- **Description**: 腾讯单独授权接口
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-11-06
- **Last Updated**: 2023-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

/*
Title: TXLicence
Description: 必须配套scrollVideoTx或者playModuleTx模块使用。
*/

<div class="outline">

[setLicence](#a1)

[getLicenceInfo](#a2)

</div>
    
## **模块接口**

<div id="a1"></div>

# **setLicence**

设置授权

setLicence({params}, callback(ret, err))

## params

licenceUrl：

- 类型：字符串
- 描述：（必填项）从腾讯云平台获取的LicenseUrl。[参考腾讯官方申请说明](https://cloud.tencent.com/document/product/584/20333#1.-.E7.94.B3.E8.AF.B7.E6.B5.8B.E8.AF.95license)

key：

- 类型：字符串
- 描述：（必填项）从腾讯云平台获取的Key。[参考腾讯官方申请说明](https://cloud.tencent.com/document/product/584/20333#1.-.E7.94.B3.E8.AF.B7.E6.B5.8B.E8.AF.95license)

## callback(ret, err)

ret：

- 类型：JSON对象
- 内部字段：

```js
{
	status: true,   //布尔型；true||false
}
```

err：

- 类型：JSON对象
- 内部字段：

```js
{
	msg: "",
}
```

## 示例代码

```js
var demo = api.require('TXLicence');
demo.setLicence({
	licenceUrl : 'http://license.vod2.myqcloud.com/license/v1/TXUgcSDK.licence',
	key : '0a8ee791929052b2dce775c308e'
},function(ret, err){
	alert(JSON.stringify(ret) +" "+ JSON.stringify(err));
});
```

## 可用性
iOS、Android系统

可提供的1.0.0及更高版本


<div id="a2"></div>

# **getLicenceInfo**

获取授权信息

setLicence(callback(ret))

## callback(ret)

ret：

- 类型：JSON对象
- 内部字段：

```js
{
	status: true,   //布尔型；true
	licence : '',  //sdk返回的授权信息字符串
}
```

## 示例代码

```js
var demo = api.require('TXLicence');
demo.getLicenceInfo(function(ret, err){
	alert(JSON.stringify(ret));
});
```

## 可用性
iOS、Android系统

可提供的1.0.0及更高版本