Interface MobileCoBrowsingModule

  • All Superinterfaces:
    UnbluModule

    public interface MobileCoBrowsingModule
    extends UnbluModule
    The API for the mobile co-browsing module. This is only usable if the corresponding module got registered during the configuration of the UnbluClient.
    • Method Detail

      • addPrivateView

        void addPrivateView​(int id)
        Adds the view with the given ID to the set of private views.

        Private views are only visible on the mobile device and won't be transmitted when co-browsing. The views will be covered before they are transmitted and therefore won't be visible on the agent side.

        Note:

        Be aware that each private view will need extra performance while capturing the UI so be cautious with the amount of private views you are adding. The best practice is to dynamically make views private, when they are displayed in the app UI and remove them from the private view list when they are not visible anymore.

        Multiple calls with the same ID do not have any effect.

        Parameters:
        id - ID of the view that should be made private.
      • removePrivateView

        void removePrivateView​(int id)
        Removes the view with the given ID from the set of private views.

        Multiple calls with the same ID do not have any effect.

        Parameters:
        id - ID of the view that should removed from the private views.
        See Also:
        addPrivateView(int)
      • setPrivateArea

        PrivateArea setPrivateArea​(java.lang.String id,
                                   int x,
                                   int y,
                                   int width,
                                   int height)
        Adds or updates a private area with the given size and position.

        Private areas are only visible on the mobile device and won't be transmitted when co-browsing. The area will be covered before the captured screen is transmitted and therefore won't be visible on the agent side.

        To update a private area either call this function with the same id again, or modify the returned PrivateArea.
        Changes to the returned private area or using this function will directly be applied, even if co-browsing is already active.

        Note:

        Try to reduce the number of private areas to a minimum as this will impact performance during co-browsing.

        Parameters:
        id - The unique id of the private area which can be used to update the values or to remove the private area again
        x - The x position on the screen for the private area
        y - The y position on the screen for the private area
        width - The width of the private area
        height - The height of the private area
        Returns:
        a PrivateArea which can be updated instead of using this API function
        See Also:
        removePrivateArea(String)