@wazo/sdk 0.38.1 → 0.38.4

package/README.md

@@ -614,7 +614,9 @@ Wazo.Softphone.init({
   language, // Softphone language (optional).
   wrapUpDuration, // How long (in seconds) should the softphone display the card after the call (optional).
   // When the user changes anything on the card, this timeout is canceled
-  withCard, // boolean: ask the softphone to display a form during and after the call to log infornation (optional).
+  enableAgent, // display the agent tab in the tab bar (defaults to true).
+  tenantId, // Tenant id used for LDAP connection
+  debug, // Set to `true` to display wording customization labels
 });
 ```
 
@@ -647,9 +649,66 @@ Wazo.Softphone.onOptionsResults(fieldId, results);
 
 `onOptionsResults` is used to populate Autocomplete fields
 
+#### Updating card value:
+```js
+Wazo.Softphone.setCardValue(field, value);
+```
+
+#### Customizing page style
+
+You can inspect the iframe with your dev tool console to figure out how to override styles.
+
+```js
+Wazo.Softphone.injectCss(`
+  # Reduce dialer number font size
+  .keypad-number, .keypad-number::placeholder {
+    font-size: 20px;
+  }
+`);
+```
+
+#### Override appearance
+```js
+Softphone.customizeAppearance({
+  // Theme, default values :
+  primary: '#203890',
+  button: '#292C87',
+  black: '#000',
+  white: '#fff',
+  greenButton: '#7ed865',
+  greenButtonHover: '#6ebf5a',
+  redButton: '#FA5846',
+  redButtonHover: '#FF604F',
+  buttonText: '#fff',
+  error: '#E80539',
+  secondary: '#203890',
+  grey: '#8A95A0',
+  secondGrey: '#eee',
+  headerColor: '#888',
+  avatar: '#bdbdbd',
+  divider: 'rgba(0, 0, 0, 0.12)',
+  placeholder: 'rgba(22, 44, 66, 0.5)',
+  hovered: '#6181F4',
+}, {
+  // Translation
+  // Set `debug: true` to know where to change translations, eg:
+  en: {
+    user: {
+      login: 'My login button', // will be displayed as `user:login` in the button when settings `debug: true` in the init() method
+    },
+  },
+}, {
+  // Assets
+  // logo: [url to your logo],
+});
+```
+
+`onOptionsResults` is used to populate Autocomplete fields
+
 #### Customizing card form
 
-You can use [JSON schema](http://json-schema.org/) to customize the card form with `Softphone.setFormSchema(schema, uiSchema)` :
+You can use [JSON schema](http://json-schema.org/) to customize the card form with `Softphone.setFormSchema(schema, uiSchema)`,
+the Softphone uses [React Json schema form](https://react-jsonschema-form.readthedocs.io) internally to display card form :
 
 ```js
 Softphone.setFormSchema({
@@ -714,6 +773,22 @@ Softphone.onCallIncoming = call => {
   // You can make action here like redirecting to the contact page (by using `call.number).
 };
 
+Softphone.onCallLocallyAnswered = call => {
+  // Invoked when the user accepts the call locally
+};
+
+Softphone.onCallEstablished = call => {
+  // Invoked when the call is up
+};
+
+Softphone.onOutgoingCallMade = call => {
+  // Invoked when the user makes a call
+};
+
+Softphone.onCallRejected = call => {
+  // Invoked when the user rejects an incoming call
+};
+
 Softphone.onCallEnded = (call, card, direction) => {
   // Invoked when the call is ended
 };
@@ -722,10 +797,6 @@ Softphone.onCardSaved = card => {
   // Invoked when the user save the card at the end of the call
 };
 
-Softphone.onCallMade = call => {
-  // Invoked when an outgoing call is made
-};
-
 Softphone.onSearchOptions = (fieldId: string, query: string) => {
   // Invoked when the user is making a search from an Autocomplete field in the card form
   // We need to call `onOptionsResults` here to send results to the softphone
@@ -744,7 +815,7 @@ Softphone.onAgentLoggedIn = () => {
   // Invoked when the agent logs in
 };
 
-Softphone.onAgentLoggedOut = ) => {
+Softphone.onAgentLoggedOut = () => {
   // Invoked when the agent logs out
 };
 
@@ -815,6 +886,10 @@ Softphone.onAuthenticated = session => {
 Softphone.onLoggedOut = session => {
   // Invoked when the user is is logged out in the softphone
 };
+
+Softphone.onIFrameLoaded = session => {
+  // Invoked when the iframe is loaded
+};
 ```
 
 ## Advanced API