Merge pull request #295 from amazon-connect/scrub_documents

Replace terms in documentation according to AWS style guide

Documentation.md

@@ -27,28 +27,28 @@ Amazon Connect Streams API works.
 ### Upgrading to the Latest Version of the CCP (AKA /ccp-v2)?
 If you are migrating to the new CCP, we encourage you to upgrade to the latest version of this repository. You should also upgrade to [the latest version of RTC-JS](https://github.com/aws/connect-rtc-js) as well, if you are using it. For a complete migration guide to the new CCP, and to fully understand the differences when using Streams with the new CCP, please see this post: https://docs.aws.amazon.com/connect/latest/adminguide/upgrade-to-latest-ccp.html. Also see: https://docs.aws.amazon.com/connect/latest/adminguide/upgrade-ccp-streams-api.html.
 
-### Whitelisting
-The first step to using the Streams API is to whitelist the pages you wish to embed.
+### Allowlisting
+The first step to using the Streams API is to allowlist the pages you wish to embed.
 For our customer's security, we require that all domains which embed the CCP for
-a particular instance are explicitly whitelisted. Each domain entry identifies
+a particular instance are explicitly allowlisted. Each domain entry identifies
 the protocol scheme, host, and port. Any pages hosted behind the same protocol
 scheme, host, and port will be allowed to embed the CCP components which are
 required to use the Streams library.
 
-To whitelist your pages:
+To allowlist your pages:
 
 1. Login to your AWS Account, then navigate to the Amazon Connect console.
-2. Choose the instance alias of the instance to whitelist
+2. Choose the instance alias of the instance to allowlist
    pages for to load the settings Overview page for your instance.
 3. Choose "Application integration" link on the left.
 4. Choose "+ Add Origin", then enter a domain URL, e.g.
    "https<nolink>://example.com", or "https<nolink>://example.com:9595" if your
    website is hosted on a non-standard port.
 
 #### A few things to note:
-* Whitelisted domains must be HTTPS.
+* Allowlisted domains must be HTTPS.
 * All of the pages that attempt to initialize the Streams library must be hosted
-  on domains that are whitelisted as per the previous steps.
+  on domains that are allowlisted as per the previous steps.
 * All open tabs that contain an initialized Streams library or any other CCP
   tabs opened will be synchronized. This means that state changes made in one
   open window will be communicated to all open windows.
@@ -244,20 +244,20 @@ connect.core.onViewContact(function(event) {
   // ...
 });
 ```
-Subscribes a callback that executes whenever the currently selected contact on the CCP changes.
+Subscribes a callback that starts whenever the currently selected contact on the CCP changes.
 The callback is called when the contact changes in the UI (i.e. via `click` events) or via `connect.core.viewContact()`.
 
 ### `connect.core.onAuthFail()`
 ```js
 connect.core.onAuthFail(function() { /* ... */ });
 ```
-Subscribes a callback that executes whenever authentication fails (e.g. SAML authentication).
+Subscribes a callback that starts whenever authentication fails (e.g. SAML authentication).
 
 ### `connect.core.onAccessDenied()`
 ```js
 connect.core.onAccessDenied(function() { /* ... */ });
 ```
-Subscribes a callback that executes whenever authorization fails (i.e. access denied).
+Subscribes a callback that starts whenever authorization fails (i.e. access denied).
 
 ### `connect.core.getWebSocketManager()`
 ```js
@@ -643,7 +643,7 @@ Subscribe a method to be invoked when the contact is pending. This event is expe
 ```js
 contact.onConnecting(function(contact) { /* ... */ });
 ```
-Subscribe a method to be invoked when the contact is connecting. This works with chat and softphone contacts. This event happens when a call or chat comes in, before accepting (there is an exception for queue callbacks, in which onConnecting's handler is executed after the callback is accepted). Note that once the contact has been accepted, the `onAccepted` handler will be triggered.
+Subscribe a method to be invoked when the contact is connecting. This works with chat and softphone contacts. This event happens when a call or chat comes in, before accepting (there is an exception for queue callbacks, in which onConnecting's handler is started after the callback is accepted). Note that once the contact has been accepted, the `onAccepted` handler will be triggered.
 
 ### `contact.onAccepted()`
 ```js

README.md

@@ -35,28 +35,28 @@ $ make
 ### Upgrading to the OmniChannel CCP (AKA CCPv2)?
 If you are migrating to the new CCP, we encourage you to upgrade to the latest version of this repository. You should also upgrade to [the latest version of RTC-JS](https://github.com/aws/connect-rtc-js) as well, if you are using it. For a complete migration guide to the new CCP, and to fully understand the differences when using Streams with the new CCP, please see this post: https://docs.aws.amazon.com/connect/latest/adminguide/upgrade-to-latest-ccp.html
 
-### Whitelisting
-The first step to using Streams is to whitelist the pages you wish to embed.
+### Allowlisting
+The first step to using Streams is to allowlist the pages you wish to embed.
 For our customer's security, we require that all domains which embed the CCP for
-a particular instance are explicitly whitelisted. Each domain entry identifies
+a particular instance are explicitly allowlisted. Each domain entry identifies
 the protocol scheme, host, and port. Any pages hosted behind the same protocol
 scheme, host, and port will be allowed to embed the CCP components which are
 required to use the Streams library.
 
-To whitelist your pages:
+To allowlist your pages:
 
 1. Login to your AWS Account, then navigate to the Amazon Connect console.
-2. Click the instance name of the instance for which you would like to whitelist
+2. Click the instance name of the instance for which you would like to allowlist
    pages to load the settings page for your instance.
 3. Click the "Application integration" link on the left.
 4. Click "+ Add Origin", then enter a domain URL, e.g.
    "https<nolink>://example.com", or "https<nolink>://example.com:9595" if your
    website is hosted on a non-standard port.
 
 #### A few things to note:
-* Whitelisted domains must be HTTPS.
+* Allowlisted domains must be HTTPS.
 * All of the pages that attempt to initialize the Streams library must be hosted
-  on domains that are whitelisted as per the above steps.
+  on domains that are allowlisted as per the above steps.
 * All open tabs that contain an initialized Streams library or any other CCP
   tabs opened will be synchronized. This means that state changes made in one
   open window will be communicated to all open windows.

src/api.js

@@ -1137,9 +1137,9 @@
   };
 
   /**
-   * Execute the given function asynchronously only if the shared worker
+   * Starts the given function asynchronously only if the shared worker
    * says we are the master for the given topic.  If there is no master for
-   * the given topic, we become the master and execute the function.
+   * the given topic, we become the master and start the function.
    *
    * @param topic The master topic we are concerned about.
    * @param f_true The callback to be invoked if we are the master.

src/index.d.ts

@@ -97,24 +97,24 @@ declare namespace connect {
     viewContact(contactId: string): void;
 
     /**
-     * Subscribes a callback that executes whenever the currently selected contact on the CCP changes.
+     * Subscribes a callback that starts whenever the currently selected contact on the CCP changes.
      * The callback is called when the contact changes in the UI (i.e. via `click` events) or via `connect.core.viewContact()`.
      *
      * @param callback A callback that will receive a `ViewContactEvent` object.
      */
     onViewContact(callback: ViewContactCallback): void;
 
     /**
-     * Subscribes a callback that executes whenever authentication fails (e.g. SAML authentication).
+     * Subscribes a callback that starts whenever authentication fails (e.g. SAML authentication).
      *
-     * @param callback A callback that will execute whenever authentication fails.
+     * @param callback A callback that will start whenever authentication fails.
      */
     onAuthFail(callback: SuccessFailCallback): void;
 
     /**
-     * Subscribes a callback that executes whenever authorization fails (i.e. access denied).
+     * Subscribes a callback that starts whenever authorization fails (i.e. access denied).
      *
-     * @param callback A callback that will execute whenever access is denied.
+     * @param callback A callback that will start whenever access is denied.
      */
     onAccessDenied(callback: SuccessFailCallback): void;
 
@@ -403,10 +403,10 @@ declare namespace connect {
   type SuccessFailCallback<T extends any[] = []> = (...args: T) => void;
 
   interface SuccessFailOptions {
-    /** A callback that executes when the operation completes successfully. */
+    /** A callback that starts when the operation completes successfully. */
     readonly success?: SuccessFailCallback;
 
-    /** A callback that executes when the operation has an error. */
+    /** A callback that starts when the operation has an error. */
     readonly failure?: SuccessFailCallback<[string]>;
   }
 
@@ -783,7 +783,7 @@ declare namespace connect {
     /**
      * Subscribe a method to be invoked when the contact is connecting.
      * This works with chat and softphone contacts.
-     * This event happens when a call or chat comes in, before accepting (there is an exception for queue callbacks, in which onConnecting's handler is executed after the callback is accepted).
+     * This event happens when a call or chat comes in, before accepting (there is an exception for queue callbacks, in which onConnecting's handler is started after the callback is accepted).
      * Note that once the contact has been accepted, the `onAccepted` handler will be triggered.
      *
      * @param callback A callback to receive the `Contact` API object instance.

src/softphone.js

@@ -134,7 +134,7 @@
           // Error! our state doesn't match, tear it all down.
           for (var connectionId in rtcSessions) {
             if (rtcSessions.hasOwnProperty(connectionId)) {
-              // Log an error for the session we are about to kill.
+              // Log an error for the session we are about to end.
               publishMultipleSessionsEvent(HANG_UP_MULTIPLE_SESSIONS_EVENT, rtcSessions[connectionId].callId, connectionId);
               destroySession(connectionId);
             }