Merge pull request #470 from salemove/MOB-1896_visitor-code-docs

Author: sm-deployer

widgetssdk/src/main/java/com/glia/widgets/GliaWidgets.java

@@ -301,7 +301,7 @@ public static Authentication getAuthentication(@NonNull Authentication.Behavior
     }
 
     /**
-     * Returns Call Visualizer module
+     * Provides controls related to the {@link CallVisualizer} module.
      */
     public static CallVisualizer getCallVisualizer() {
         return Dependencies.getCallVisualizerManager();

widgetssdk/src/main/java/com/glia/widgets/UiTheme.kt

@@ -139,19 +139,19 @@ data class UiTheme(
     val gliaChatHeaderExitQueueButtonTintColor: Int? = null,
 
     /**
-     * TODO: MOB-1896
+     * Color for Visitor Code numbers
      */
     @ColorRes
     val visitorCodeTextColor: Int? = null,
 
     /**
-     * TODO: MOB-1896
+     * Color for Visitor Code number slots background
      */
     @ColorRes
     val visitorCodeBackgroundColor: Int? = null,
 
     /**
-     * TODO: MOB-1896
+     * Color for Visitor Code number slots border
      */
     @ColorRes
     val visitorCodeBorderColor: Int? = null,

widgetssdk/src/main/java/com/glia/widgets/core/callvisualizer/domain/CallVisualizer.java

@@ -6,16 +6,30 @@
 
 /**
  * Provides controls related to Call Visualizer module
- * TODO: improve docs in MOB-1816
+ *
+ * Some interactions between operators and visitors start as regular phone calls with no Glia engagement.
+ * Screen sharing and video engagements are available for such calls via Call Visualizer.
+ *
+ * For more information, see the <a href="https://docs.glia.com/glia-mobile/docs/android-widgets-call-visualizer">Call Visualizer guide</a>.
  */
 public interface CallVisualizer {
     /**
-     * This builds a VisitorCodeView component that can be integrated in the client application
+     * Creates a VisitorCodeView component that can be integrated into the client application
+     *
+     * The visitor code is generated on demand and is unique for every visitor on a particular site.
+     * The first time this function is called for a visitor, the code is generated and returned.
+     * For each subsequent call thereafter, the same code will be returned as long as the code has not
+     * expired. During that time, the code can be used to initiate an engagement. Once the operator
+     * has used the visitor code to initiate an engagement, the code will expire immediately.
      */
     VisitorCodeView createVisitorCodeView(Context context);
 
     /**
-     * This shows Visitor Code inside a Dialog on top of current Activity inside of your application
+     * Shows the visitor code in a dialog box on top of the current activity within your application.
+     *
+     * This dialog will overlay on top of any other dialogs without dismissing them.
+     *
+     * Otherwise, it behaves the same way as {@link #createVisitorCodeView(Context)}.
      */
     void showVisitorCodeDialog(Context context);
 

widgetssdk/src/main/java/com/glia/widgets/view/VisitorCodeView.kt

@@ -23,11 +23,13 @@ import com.glia.widgets.view.unifiedui.exstensions.applyLayerTheme
 import com.glia.widgets.view.unifiedui.exstensions.applyTextTheme
 import com.glia.widgets.view.unifiedui.exstensions.layoutInflater
 import com.google.android.material.theme.overlay.MaterialThemeOverlay
+import com.glia.widgets.core.callvisualizer.domain.CallVisualizer
 
 /**
- * TODO: add doc in MOB-1816
- * TODO: N.B: this view is not expected to be used by integrator or view XML
- * TODO: Test what will happen if I add it to XML regardless
+ * A view for displaying the visitor code to the visitor.
+ *
+ * This view should not be instantiated directly - neither programmatically nor inside your XML layouts.
+ * Use [CallVisualizer.createVisitorCodeView] to create an instance of this view.
  */
 class VisitorCodeView internal constructor(
     context: Context