Class OnboardingLink


  • public class OnboardingLink
    extends Object
    OnboardingLink
    • Constructor Detail

      • OnboardingLink

        public OnboardingLink()
    • Method Detail

      • url

        public OnboardingLink url​(String url)
        The URL of the hosted onboarding page where you need to redirect your user. This URL: - Expires after 4 minutes. - Can only be used once. - Can only be clicked once by the user. If the link expires, you need to create a new link.
        Parameters:
        url - The URL of the hosted onboarding page where you need to redirect your user. This URL: - Expires after 4 minutes. - Can only be used once. - Can only be clicked once by the user. If the link expires, you need to create a new link.
        Returns:
        the current OnboardingLink instance, allowing for method chaining
      • getUrl

        public String getUrl()
        The URL of the hosted onboarding page where you need to redirect your user. This URL: - Expires after 4 minutes. - Can only be used once. - Can only be clicked once by the user. If the link expires, you need to create a new link.
        Returns:
        url The URL of the hosted onboarding page where you need to redirect your user. This URL: - Expires after 4 minutes. - Can only be used once. - Can only be clicked once by the user. If the link expires, you need to create a new link.
      • setUrl

        public void setUrl​(String url)
        The URL of the hosted onboarding page where you need to redirect your user. This URL: - Expires after 4 minutes. - Can only be used once. - Can only be clicked once by the user. If the link expires, you need to create a new link.
        Parameters:
        url - The URL of the hosted onboarding page where you need to redirect your user. This URL: - Expires after 4 minutes. - Can only be used once. - Can only be clicked once by the user. If the link expires, you need to create a new link.
      • includeNullValues

        public OnboardingLink includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this OnboardingLink object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static OnboardingLink fromJson​(String jsonString)
                                       throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of OnboardingLink given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of OnboardingLink
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to OnboardingLink
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of OnboardingLink to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException