@paydock/client-sdk/docs/api-canvas3ds.md

Paydock client sdk

## Classes

<dl>
<dt><a href="#Canvas3ds">Canvas3ds</a></dt>
<dd><p>Class Canvas3ds include method for working on html</p>
</dd>
</dl>

## Constants

<dl>
<dt><a href="#EVENT">EVENT</a> : <code>object</code></dt>
<dd><p>List of available event&#39;s name</p>
</dd>
<dt><a href="#STANDALONE_3DS_EVENT">STANDALONE_3DS_EVENT</a> : <code>object</code></dt>
<dd><p>List of available event&#39;s name for Standalone 3ds flow</p>
</dd>
</dl>

<a name="Canvas3ds" id="Canvas3ds" href="#Canvas3ds">&nbsp;</a>

## Canvas3ds
Class Canvas3ds include method for working on html

**Kind**: global class  

* [Canvas3ds](#Canvas3ds)
    * [new Canvas3ds(selector, token)](#new_Canvas3ds_new)
    * [.load()](#Canvas3ds+load)
    * [.setEnv(env, [alias])](#Canvas3ds+setEnv)
    * [.on(eventName, [cb])](#Canvas3ds+on) ⇒ <code>Promise.&lt;IEventData&gt;</code> \| <code>void</code>
    * [.hide([saveSize])](#Canvas3ds+hide)
    * [.show()](#Canvas3ds+show)
    * [.reload()](#Canvas3ds+reload)

<a name="new_Canvas3ds_new" id="new_Canvas3ds_new" href="#new_Canvas3ds_new">&nbsp;</a>

### new Canvas3ds(selector, token)

| Param | Type | Description |
| --- | --- | --- |
| selector | <code>string</code> | Selector of html element. Container for widget |
| token | <code>string</code> | Pre authorized token |

**Example**  
```js
var widget = new Canvas3ds('#widget', 'token');
```
<a name="Canvas3ds+load" id="Canvas3ds+load" href="#Canvas3ds+load">&nbsp;</a>

### canvas3ds.load()
The final method to beginning, the load process of widget to html

**Kind**: instance method of [<code>Canvas3ds</code>](#Canvas3ds)  
<a name="Canvas3ds+setEnv" id="Canvas3ds+setEnv" href="#Canvas3ds+setEnv">&nbsp;</a>

### canvas3ds.setEnv(env, [alias])
Current method can change environment. By default environment = sandbox.
Also we can change domain alias for this environment. By default domain_alias = paydock.com

**Kind**: instance method of [<code>Canvas3ds</code>](#Canvas3ds)  

| Param | Type | Description |
| --- | --- | --- |
| env | <code>string</code> | sandbox, production |
| [alias] | <code>string</code> | Own domain alias |

**Example**  
```js
widget.setEnv('production');
```
<a name="Canvas3ds+on" id="Canvas3ds+on" href="#Canvas3ds+on">&nbsp;</a>

### canvas3ds.on(eventName, [cb]) ⇒ <code>Promise.&lt;IEventData&gt;</code> \| <code>void</code>
Listen to events of widget

**Kind**: instance method of [<code>Canvas3ds</code>](#Canvas3ds)  

| Param | Type | Description |
| --- | --- | --- |
| eventName | <code>string</code> | Available event names [EVENT](#EVENT) [STANDALONE_3DS_EVENT](#STANDALONE_3DS_EVENT) |
| [cb] | <code>listener</code> |  |

**Example**  
```js
widget.on('chargeAuthReject', function (data) {
     console.log(data);
});
// or
widget.on('chargeAuthReject').then(function (data) {
     console.log(data);
});
```
<a name="Canvas3ds+hide" id="Canvas3ds+hide" href="#Canvas3ds+hide">&nbsp;</a>

### canvas3ds.hide([saveSize])
Using this method you can hide widget after load

**Kind**: instance method of [<code>Canvas3ds</code>](#Canvas3ds)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |

<a name="Canvas3ds+show" id="Canvas3ds+show" href="#Canvas3ds+show">&nbsp;</a>

### canvas3ds.show()
Using this method you can show widget after using hide method

**Kind**: instance method of [<code>Canvas3ds</code>](#Canvas3ds)  
<a name="Canvas3ds+reload" id="Canvas3ds+reload" href="#Canvas3ds+reload">&nbsp;</a>

### canvas3ds.reload()
Using this method you can reload widget

**Kind**: instance method of [<code>Canvas3ds</code>](#Canvas3ds)  
<a name="TOKEN_FORMAT" id="TOKEN_FORMAT" href="#TOKEN_FORMAT">&nbsp;</a>

## TOKEN\_FORMAT : <code>enum</code>
List of available token's content formats

**Kind**: global enum  

| Param | Type | Default |
| --- | --- | --- |
| HTML | <code>string</code> | <code>&quot;html&quot;</code> | 

<a name="EVENT" id="EVENT" href="#EVENT">&nbsp;</a>

## EVENT : <code>object</code>
List of available event's name

**Kind**: global constant  

| Param | Type | Default |
| --- | --- | --- |
| CHARGE_AUTH_SUCCESS | <code>string</code> | <code>&quot;chargeAuthSuccess&quot;</code> | 
| CHARGE_AUTH_REJECT | <code>string</code> | <code>&quot;chargeAuthReject&quot;</code> | 
| ADDITIONAL_DATA_SUCCESS | <code>string</code> | <code>&quot;additionalDataCollectSuccess&quot;</code> | 
| ADDITIONAL_DATA_REJECT | <code>string</code> | <code>&quot;additionalDataCollectReject&quot;</code> | 
| CHARGE_AUTH | <code>string</code> | <code>&quot;chargeAuth&quot;</code> | 

<a name="STANDALONE_3DS_EVENT" id="STANDALONE_3DS_EVENT" href="#STANDALONE_3DS_EVENT">&nbsp;</a>

## STANDALONE\_3DS\_EVENT : <code>object</code>
List of available event's name for Standalone 3ds flow

**Kind**: global constant  

| Param | Type | Default |
| --- | --- | --- |
| CHARGE_AUTH_SUCCESS | <code>string</code> | <code>&quot;chargeAuthSuccess&quot;</code> | 
| CHARGE_AUTH_REJECT | <code>string</code> | <code>&quot;chargeAuthReject&quot;</code> | 
| CHARGE_AUTH_DECOUPLED | <code>string</code> | <code>&quot;chargeAuthDecoupled&quot;</code> | 
| CHARGE_AUTH_CHALLENGE | <code>string</code> | <code>&quot;chargeAuthChallenge&quot;</code> | 
| CHARGE_AUTH_INFO | <code>string</code> | <code>&quot;chargeAuthInfo&quot;</code> | 
| ERROR | <code>string</code> | <code>&quot;error&quot;</code> |