Skip to content

Commit

Permalink
fix: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
riderx committed Nov 3, 2022
1 parent 17a2264 commit cddbf50
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Capacitor Updator works by unzipping a compiled app bundle to the native device
* [`setDelay(...)`](#setdelay)
* [`cancelDelay()`](#canceldelay)
* [`getLatest()`](#getlatest)
* [`setChannel()`](#setchannel)
* [`setChannel(...)`](#setchannel)
* [`addListener('download', ...)`](#addlistenerdownload)
* [`addListener('noNeedUpdate', ...)`](#addlistenernoneedupdate)
* [`addListener('updateAvailable', ...)`](#addlistenerupdateavailable)
Expand Down Expand Up @@ -350,14 +350,18 @@ Get Latest bundle available from update Url
--------------------


### setChannel()
### setChannel(...)

```typescript
setChannel() => Promise<channelRes>
setChannel(options: SetChannelOptions) => Promise<channelRes>
```

Set Channel for this device

| Param | Type | Description |
| ------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **`options`** | <code><a href="#setchanneloptions">SetChannelOptions</a></code> | are the {@link <a href="#setchanneloptions">SetChannelOptions</a>} list to set |

**Returns:** <code>Promise&lt;<a href="#channelres">channelRes</a>&gt;</code>

**Since:** 4.7.0
Expand Down Expand Up @@ -630,6 +634,13 @@ removeAllListeners() => Promise<void>
| **`error`** | <code>any</code> | | |


#### SetChannelOptions

| Prop | Type |
| ------------- | ------------------- |
| **`chhanel`** | <code>string</code> |


#### PluginListenerHandle

| Prop | Type |
Expand Down

0 comments on commit cddbf50

Please sign in to comment.