@@ -7,13 +7,13 @@ GliaWidgets SDK is a simple and customisable framework built on top of GliaSDK.
7
7
To install the @salemove /widgets_sdk_ionic package use:
8
8
9
9
``` text
10
- npm install @salemove/widgets_sdk_ionic
10
+ npm install @salemove/widgets_sdk_ionic --legacy-peer-deps
11
11
```
12
12
13
13
# How to use GliaSDK in Ionic environment
14
14
15
15
``` js
16
- // Import `glia-widgets-ionic` plugin
16
+ // Import `glia-widgets-ionic` SDK
17
17
import { GliaSdk } from ' glia-widgets-ionic' ;
18
18
19
19
// Configure SDK
@@ -24,8 +24,8 @@ GliaSdk.configure({
24
24
companyName: ' Ionic Company' ,
25
25
});
26
26
27
- // Start engagement
28
- GliaSdk .startAudio ();
27
+ // Show Entry Widget
28
+ GliaSdk .presentEntryWidget ();
29
29
```
30
30
31
31
## API
@@ -61,9 +61,9 @@ GliaSdk.startAudio();
61
61
configure (options : { siteId: string ; queueIds ?: string []; apiKey : ApiKey ; region : Region ; companyName : string ; overrideLocale ?: string ; }) => Promise < void >
62
62
```
63
63
64
- configures GliaWidgets SDK with credentials.
64
+ Configures GliaWidgets SDK with credentials.
65
65
66
- NB! To make plugin work properly, use ` create-visitor ` credentials for Site APIKey only.
66
+ NB! Ensure the site API key used in Mobile SDK has the Create Visitor permission only.
67
67
68
68
| Param | Type |
69
69
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -122,7 +122,7 @@ Starts a new video engagement for queue identifiers. If `queueIds` is null or em
122
122
startSecureConversation () => Promise < void >
123
123
```
124
124
125
- Starts Secure Conversation flow with passed ` start screen ` .
125
+ Starts Secure Conversation flow.
126
126
Secure Conversation requires authentication/IdToken.
127
127
128
128
--------------------
@@ -147,8 +147,6 @@ listQueues() => Promise<any>
147
147
148
148
Fetches all queues with its info for current site.
149
149
150
- ** Returns:** <code >Promise< ; any> ; </code >
151
-
152
150
--------------------
153
151
154
152
@@ -195,7 +193,7 @@ Deauthenticates visitor. Be aware that deauthentication process relies on <a hre
195
193
isAuthenticated () => Promise < void >
196
194
```
197
195
198
- Provides current authentication state
196
+ Provides current authentication state.
199
197
200
198
--------------------
201
199
0 commit comments