Package com.pubmatic.sdk.webrendering.ui

Class POBHTMLRenderer

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public boolean isUserInteracted

    • Constructor Summary

      Constructors 
      Constructor Description
      POBHTMLRenderer(POBWebView pmWebView, POBHTMLViewClient webViewClient) Constructs HTML Renderer by using PMWebView and HTMLView client.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      boolean isUserInteracted() To get the state of WebView user interaction.
      void setUserInteracted(boolean userInteracted) To set the state of WebView user interaction.
      void setRenderingTimeout(int renderingTimeout) To set rendering timeout, in case if renderer takes more time than rendering timeout to render renderer notifies rendering timeout error.
      void setRendererViewListener(@Nullable() POBHtmlRendererListener listener) Method Provides Renderer callback to implementation class
      void loadHTML(@Nullable() String content, @Nullable() String baseURL, boolean isCompanion) Generate content specific to WebView rendering/loading and loads it in webview with provided base url
      boolean shouldOverrideUrlLoading(@Nullable() String url) Gets called when URL is about to be load in the current WebView.
      void onPageFinished(@NonNull() WebView view) To notify view is about render.
      void onReceivedError(@NonNull() POBError error) To notify rederer is failed to load ad.
      void destroy() Clearing all the data related to HTML Renderer.
      void invalidateWebView() Invalidate WebView

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • POBHTMLRenderer

        POBHTMLRenderer(POBWebView pmWebView, POBHTMLViewClient webViewClient)
        Constructs HTML Renderer by using PMWebView and HTMLView client.
        Parameters:
        pmWebView - instance of PMWebView required
        webViewClient - instance of HTMLViewClient

    • Method Detail

      • isUserInteracted

         boolean isUserInteracted()

        To get the state of WebView user interaction.

        Returns:

        state of WebView user interaction

      • setUserInteracted

         void setUserInteracted(boolean userInteracted)

        To set the state of WebView user interaction.

        Parameters:
        userInteracted - state of the WebView user interaction.

      • setRenderingTimeout

         void setRenderingTimeout(int renderingTimeout)

        To set rendering timeout, in case if renderer takes more time than rendering timeout to render renderer notifies rendering timeout error. In order to execute properly set before loadHTML For default value see MAX_RENDER_TIMEOUT_IN_SEC

        Parameters:
        renderingTimeout - the timeout in seconds.

      • setRendererViewListener

         void setRendererViewListener(@Nullable() POBHtmlRendererListener listener)

        Method Provides Renderer callback to implementation class

        Parameters:
        listener - reference of PMHtmlRendererListener

      • loadHTML

         void loadHTML(@Nullable() String content, @Nullable() String baseURL, boolean isCompanion)

        Generate content specific to WebView rendering/loading and loads it in webview with provided base url

        Parameters:
        content - content which is to be formatter
        baseURL - on which formatted content to be loaded
        isCompanion - whether it is rendered on video companion

      • shouldOverrideUrlLoading

         boolean shouldOverrideUrlLoading(@Nullable() String url)

        Gets called when URL is about to be load in the current WebView.

        Parameters:
        url - the url which is going to be loaded
        Returns:

        returning true causes the current WebView to abort loading the URL, while returning false causes the WebView to continue loading the URL as usual.

      • onReceivedError

         void onReceivedError(@NonNull() POBError error)

        To notify rederer is failed to load ad.

        Parameters:
        error - value of POBError

      • destroy

         void destroy()

        Clearing all the data related to HTML Renderer.