BeginGetPasswordOption.kt
/*
* Copyright 2022 The Android Open Source Project
*
* 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 androidx.credentials.provider
import android.os.Bundle
import android.service.credentials.BeginGetCredentialResponse
import androidx.credentials.PasswordCredential
/**
* A request to a password provider to begin the flow of retrieving the user's saved passwords.
*
* Providers must use the parameters in this option to retrieve the corresponding credentials'
* metadata, and then return them in the form of a list of [PasswordCredentialEntry]
* set on the [BeginGetCredentialResponse].
*
* Note : Credential providers are not expected to utilize the constructor in this class for any
* production flow. This constructor must only be used for testing purposes.
*/
class BeginGetPasswordOption constructor(
candidateQueryData: Bundle,
id: String
) : BeginGetCredentialOption(
id,
PasswordCredential.TYPE_PASSWORD_CREDENTIAL,
candidateQueryData
) {
/** @hide **/
@Suppress("AcronymName")
companion object {
/** @hide */
@JvmStatic
internal fun createFrom(data: Bundle, id: String): BeginGetPasswordOption {
return BeginGetPasswordOption(data, id)
}
/** @hide */
@JvmStatic
internal fun createFromEntrySlice(data: Bundle, id: String): BeginGetPasswordOption {
return BeginGetPasswordOption(data, id)
}
}
}