Package com.unblu.sdk.core.model

Class UiVisibilityRequestModel

  • public class UiVisibilityRequestModel
extends java.lang.Object
    Encapsulates a request to change the visibility of the Unblu UI component within the app. This model holds information about the reason for the visibility change request, the ID of the associated conversation (if any), and whether the request was initiated by a user action. It provides a structured way to manage and convey requests for showing or hiding the Unblu UI, facilitating the application's ability to respond appropriately based on the context of the request.

    • Constructor Summary

      Constructors 
      Constructor Description
      UiVisibilityRequestModel​(UnbluUiRequestReason reason, java.lang.String conversationId, boolean requestedByUser)
      Constructs a new UiVisibilityRequestModel with the specified parameters for the visibility change request.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getConversationId()
      Returns the ID of the conversation associated with the visibility change request.
      UnbluUiRequestReason getReason()
      Returns the reason for the visibility change request.
      boolean isRequestedByUser()
      Indicates whether the visibility change request was initiated by a user.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UiVisibilityRequestModel

        public UiVisibilityRequestModel​(UnbluUiRequestReason reason,
                                java.lang.String conversationId,
                                boolean requestedByUser)
        Constructs a new UiVisibilityRequestModel with the specified parameters for the visibility change request.
        Parameters:
        reason - The reason for the visibility change, categorized by UnbluUiRequestReason.
        conversationId - The ID of the conversation related to the visibility change request, or null if not applicable.
        requestedByUser - A boolean flag indicating whether the request was initiated by a user action (true) or not (false).

    • Method Detail

      • getReason

        public UnbluUiRequestReason getReason()
        Returns the reason for the visibility change request.
        Returns:
        The reason for requesting a change in the UI's visibility, as defined by UnbluUiRequestReason.

      • getConversationId

        public java.lang.String getConversationId()
        Returns the ID of the conversation associated with the visibility change request.
        Returns:
        The conversation ID related to the request, or null if the request is not associated with a specific conversation.

      • isRequestedByUser

        public boolean isRequestedByUser()
        Indicates whether the visibility change request was initiated by a user.
        Returns:
        true if the request was initiated by the user, false otherwise.