commonMain.com.twilio.passkeys.AuthenticatePasskeyResult.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twilio-verify-passkeys-common

Twilio Passkeys SDK enables developers to easily add Passkeys into their existing authentication flows within their own mobile applications. The Verify Passkeys SDK supports passkeys creation and authentication using the FIDO/WebAuthn industry standard.

The newest version!

/*
 * Copyright © 2024 Twilio Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.twilio.passkeys

import com.twilio.passkeys.exception.TwilioException
import com.twilio.passkeys.models.AuthenticatePasskeyResponse

/**
 * Sealed class representing the result of authenticating a passkey.
 */
sealed class AuthenticatePasskeyResult {
  /**
   * Represents a successful passkey authentication result.
   *
   * @param authenticatePasskeyResponse The response containing information about the passkey authentication.
   */
  data class Success(val authenticatePasskeyResponse: AuthenticatePasskeyResponse) :
    AuthenticatePasskeyResult()

  /**
   * Represents an error that occurred during passkey authentication.
   *
   * @param error The exception representing the error.
   */
  data class Error(val error: TwilioException) : AuthenticatePasskeyResult()
}