Package com.my.target.common.webform

Interface WebFormClient

  • All Implemented Interfaces:
    
public interface WebFormClient

    The methods for responding to the web form appearance, dismissal, text copying and handling post messages.

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract UserInfo getCustomSdkUserInfo(@NonNull() WebForm webForm) Indicates that the web form handled the get user info post message.
      abstract void getCustomSdkUserInfo(@NonNull() WebForm webForm, @NonNull() WebFormClient.CustomSdkUserInfoCallback callback) Asynchronous provisioning of user info post message: The implementation asynchronously requests information from the server and then calls callback with that data.
      abstract View getErrorView(@NonNull() String error, @NonNull() WebForm webForm) Returns a view to show specific error
      abstract void onCopyText(@NonNull() String text, @NonNull() WebForm webForm) Indicates that the web form copied the text.
      abstract void onDismiss(@NonNull() WebForm webForm) Indicates that the web form dismissed.
      abstract void onPresent(@NonNull() WebForm webForm) Indicates that the web form will present.
      abstract void setViewSettings(@NonNull() WebFormSetViewSettings settings, @NonNull() WebForm webForm) Indicates that the web form handled the set view settings post message.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getCustomSdkUserInfo

        @Deprecated()@Nullable() abstract UserInfo getCustomSdkUserInfo(@NonNull() WebForm webForm)

        Indicates that the web form handled the get user info post message.

        Parameters:
        webForm - The web form that handle the post message.
        Returns:

        @return The result of getting user info.

      • getCustomSdkUserInfo

         abstract void getCustomSdkUserInfo(@NonNull() WebForm webForm, @NonNull() WebFormClient.CustomSdkUserInfoCallback callback)

        Asynchronous provisioning of user info post message: The implementation asynchronously requests information from the server and then calls callback with that data.

        Parameters:
        webForm - The web form that handle the post message.
        callback - Callback to provide UserInfo data.

      • getErrorView

        @Nullable() abstract View getErrorView(@NonNull() String error, @NonNull() WebForm webForm)

        Returns a view to show specific error

        Parameters:
        error - The error for which the error view is being shown.
        webForm - The web form that shows the error view.
        Returns:

        An error view or `null`.

      • onCopyText

         abstract void onCopyText(@NonNull() String text, @NonNull() WebForm webForm)

        Indicates that the web form copied the text.

        Parameters:
        text - The text that was copied.
        webForm - The web form that copied the text.

      • onDismiss

         abstract void onDismiss(@NonNull() WebForm webForm)

        Indicates that the web form dismissed.

        Parameters:
        webForm - The web form that dismissed.

      • onPresent

         abstract void onPresent(@NonNull() WebForm webForm)

        Indicates that the web form will present.

        Parameters:
        webForm - The web form that’s about to appear.

      • setViewSettings

         abstract void setViewSettings(@NonNull() WebFormSetViewSettings settings, @NonNull() WebForm webForm)

        Indicates that the web form handled the set view settings post message.

        Parameters:
        settings - The post message result with view settings data.
        webForm - The web form that handle the post message.