Class CaptchaResult

    • Method Detail

      • isValid

        public boolean isValid()
        If configured to false, PingFederate will treat the CAPTCHA process as failed.
        Returns:
        whether the CAPTCHA was successful.
      • getResponseAttributes

        public AttributeMap getResponseAttributes()
        The response attributes provide more information about the CAPTCHA process back to PingFederate which can then be used downstream in the flow.
        Returns:
        A AttributeMap containing attributes from the CAPTCHA validation which may be used downstream in flow.
      • createValidResult

        public static CaptchaResult createValidResult​(AttributeMap responseAttributes)
        Creates a new CaptchaResult instance to represent a valid CAPTCHA result.
        Parameters:
        responseAttributes - A AttributeMap containing attributes from the CAPTCHA validation which may be used downstream in flow.
      • createInvalidResult

        public static CaptchaResult createInvalidResult​(AttributeMap responseAttributes)
        Creates a new CaptchaResult instance to represent a invalid CAPTCHA result.
        Parameters:
        responseAttributes - A AttributeMap containing attributes from the CAPTCHA validation which may be used downstream in flow.