Glia

Omnibrowse instance, can be used to perform OmniBrowse specific actions.

Cancels Visitor's Engagement Request.

Behaves same way as cancel(Consumer) only you have to manually specify Engagement Request ID.

Cancels Visitor's spot in the queue.

Behaves same way as cancel(Consumer) only you have to manually specify Queue ticket ID.

Retrieves file content stream.

To close network connection ensure to call close() even if you have not performed any actions with the stream.

     
         fileDownloadIcon.setOnClickListener(view -> {
             Glia.fetchFile(attachmentFile, (fileInputStream, exception) -> {
                 if (exception != null) {
                     // Something went wrong when trying to retrieve file content
                     // Show some error message
                     return;
                 }

                 try (FileOutputStream newFileStream = new FileOutputStream(YOUR_FILE_PATH)) {
                     int length;
                     byte[] buffer = new byte[1024];
                     while ((length = fileInputStream.read(buffer)) != -1) {
                         newFileStream.write(buffer, 0, length);
                     }
                     newFileStream.flush();
                 } finally {
                     fileInputStream.close();
                 }
             });
         });
     
 

Returns Visitor's chat history

Includes all Operator and Visitor chat messages from previous and/or ongoing Engagements that were sent prior to calling this method.

Returns current Engagement if exists.

This method is useful when you need to access current Engagement instance in an activity that is different from the activity that received ENGAGEMENT event.

Deprecated since SDK version 0.22.0

Gets a list of all Queues.

This information can be used to enqueue by Queue ID by queueForEngagement(String, VisitorContext, Consumer).

Usage example:

You might have multiple Operator Queues for different purposes. Let's say one is named 'regular' and is for normal Visitors while another is 'premium' for VIP Visitors. In this case you can check state of Queues by fetching their information and assigning your Engagement dynamically to more fitting Queue.

 
 Glia.getQueues((queues, exception) -> {
     runOnUiThread(() -> {
         if (queues != null) {
             makeEnqueue(queues);
         }
         if (exception != null && exception.cause.equals(GliaException.Cause.NETWORK_TIMEOUT)) {
             showNetworkError();
         }
     });
 });
 
 

Fetches the visitor's information

If visitor is authenticated, the response will include the attributes and tokens fetched from the authentication provider.

Initializes Glia SDK using GliaConfig.

Use it one time when the app starts to initialize Glia SDK with necessary configuration.

Example:

Glia.init(new GliaConfig.Builder()
   .setAppToken("APP_TOKEN")
   .setSiteId("SITE_ID")
   .setRegion(Region.US)
   .build()
 );
 

Checks result of Glia initialization

Removes event listeners from OmniCore.

If an event listener is removed while the OmniCore is processing an event, it is not triggered with the current event.

Calling off with arguments which do not identify any currently registered listener has no effect.

Calling before SDK is initialized results in runtime exception GliaException with INVALID_INPUT cause.

Removes all event listeners from OmniCore.

Behaves the same way as off(OmnicoreEvent, Consumer) but removes all listeners of specified type

Registers event listeners for Omnicore.

If a listener is added while the Omnicore is processing an event, it is not triggered with the current event.

If multiple identical listeners are registered on the same event type the duplicate instances are discarded. They do not cause the listener to be called twice and do not need to be removed with the off(OmnicoreEvent) or off(OmnicoreEvent, Consumer) method.

Calling before SDK is initialized results in runtime exception GliaException with INVALID_INPUT cause.

Configures Glia SDK application lifecycle related settings.

Should be called from onCreate()

Accepts permissions request results.

Some functionalities, for example Video or Audio calls, require to request runtime permissions via Activity#requestPermissions(String[], int). The results of such request is passed to your activity's Activity#onRequestPermissionsResult(int, String[], int[])

Your activity in turn must call this method to pass the results of the request to Glia SDK.

This method is no-op for other non-Glia triggered results.

Enqueues the Visitor for text Engagement. While audio or video media engagement intended, client must call onRequestPermissionsResult(int, String[], int[]) within a calling screen. In case of audio\video media type specified (@param mediaType), first argument there must be equal to (@param mediaPermissionRequestCode)

On high-traffic Sites, Visitors looking for Engagements can greatly outnumber the available Operators. To be able to still provide best possible user experience under these circumstances, Glia provides a way for Visitors to queue for Engagements.

When the Visitor was successfully put into to Queue QUEUE_TICKET event is triggered with an instance of QueueTicket. QueueTicket can be used to cancel queueing using cancel(Consumer) or cancelQueueTicket(String, Consumer).

Visitors who have entered the Queue is, in turn, Engaged with an appropriate Operator as soon as one becomes available and accepts the Engagement Request. Once that happens ENGAGEMENT event is triggered. See on(OmnicoreEvent, Consumer) for more info regarding OmniCore events.

Usage example:

 
 Glia.queueForEngagement(yourQueueId, mediaType, visitorContext, MEDIA_PERMISSION_CODE, response -> {
      if (response != null) {
          Log.e("Glia", "Failed to queue for Engagement: " + response.toString());
          return;
      }

      Log.i("Glia", "Visitor successfully enqueued, waiting for Operator to accept Engagement");
 });
 
 

Enqueues the Visitor for TEXT type Engagement.

Behaves same way as calling the queueForEngagement(String, Engagement.MediaType, VisitorContext, Consumer) with the TEXT media type.

Sends Engagement request to specific Operator with possibility to choose engagement media type (text/audio/video).

While audio or video media engagement intended, client must call onRequestPermissionsResult(int, String[], int[]) with the same int passed to the first argument as passed to this function (@param mediaPermissionRequestCode) within a calling screen.

Once request is successfully sent and Operator and approved then an Engagement is started and ENGAGEMENT trigger is fired.

Code example:

 
 VisitorContext visitorContext = new VisitorContext(VisitorContext.Type.PAGE, "https://example.com/");
 Glia.requestEngagement(operatorId, visitorContext, Engagement.MediaType.VIDEO, MEDIA_PERMISSION_CODE, (engagementRequest, error) -> {
     if (error != null) {
         // Failed to send Engagement Request
         return;
     }

     // Engagement request was sent successfully, waiting for Operator to approve.
 });
 
 

Sends Engagement request to specific Operator. Once request is successfully sent and Operator approved it an Engagement is started and ENGAGEMENT trigger is fired.

Behaves same way as calling the #requestEngagement(String, VisitorContext, Engagement.MediaType, EngagementOptions, int, RequestCallback) with the TEXT media type.

Subscribes to state updates of one or multiple Queues.

Allows to subscribe to Queue state updates of a specific Queue. This can be useful when there is a need to have multiple integration points, for example buttons, corresponding to different Queues.

Subscribes to state updates of one or multiple Queues.

Behaves same way as subscribeToQueueStateUpdates(String[], Consumer, Consumer)

Unsubscribes from Queue state updates currently subscribed with subscribeToQueueStateUpdates(String, Consumer, Consumer) or subscribeToQueueStateUpdates(String[], Consumer, Consumer)

Updates the visitor's information

Updates the visitor's information stored on the server. This information will also be displayed to the operator.