AbstractAccountAuthenticator.StartUpdateCredentialsSession Method

Definition

Asks user to re-authenticate for an account but defers updating the locally stored credentials.

[Android.Runtime.Register("startUpdateCredentialsSession", "(Landroid/accounts/AccountAuthenticatorResponse;Landroid/accounts/Account;Ljava/lang/String;Landroid/os/Bundle;)Landroid/os/Bundle;", "GetStartUpdateCredentialsSession_Landroid_accounts_AccountAuthenticatorResponse_Landroid_accounts_Account_Ljava_lang_String_Landroid_os_Bundle_Handler", ApiSince=26)]
public virtual Android.OS.Bundle? StartUpdateCredentialsSession (Android.Accounts.AccountAuthenticatorResponse? response, Android.Accounts.Account? account, string? authTokenType, Android.OS.Bundle? options);
[<Android.Runtime.Register("startUpdateCredentialsSession", "(Landroid/accounts/AccountAuthenticatorResponse;Landroid/accounts/Account;Ljava/lang/String;Landroid/os/Bundle;)Landroid/os/Bundle;", "GetStartUpdateCredentialsSession_Landroid_accounts_AccountAuthenticatorResponse_Landroid_accounts_Account_Ljava_lang_String_Landroid_os_Bundle_Handler", ApiSince=26)>]
abstract member StartUpdateCredentialsSession : Android.Accounts.AccountAuthenticatorResponse * Android.Accounts.Account * string * Android.OS.Bundle -> Android.OS.Bundle
override this.StartUpdateCredentialsSession : Android.Accounts.AccountAuthenticatorResponse * Android.Accounts.Account * string * Android.OS.Bundle -> Android.OS.Bundle

Parameters

response
AccountAuthenticatorResponse

to send the result back to the AccountManager, will never be null

account
Account

the account whose credentials are to be updated, will never be null

authTokenType
String

the type of auth token to retrieve after updating the credentials, may be null

options
Bundle

a Bundle of authenticator-specific options, may be null

Returns

a Bundle result or null if the result is to be returned via the response. The result will contain either: <ul> <li>AccountManager#KEY_INTENT, or <li>AccountManager#KEY_ACCOUNT_SESSION_BUNDLE for updating the locally stored credentials later, and if account is re-authenticated, optional AccountManager#KEY_PASSWORD and AccountManager#KEY_ACCOUNT_STATUS_TOKEN for checking the status of the account later, or <li>AccountManager#KEY_ERROR_CODE and AccountManager#KEY_ERROR_MESSAGE to indicate an error </ul>

Attributes

Remarks

Asks user to re-authenticate for an account but defers updating the locally stored credentials. No file I/O should be performed in this call. Local credentials should be updated only when #finishSession is called after this.

Note: when overriding this method, #finishSession should be overridden too.

Java documentation for android.accounts.AbstractAccountAuthenticator.startUpdateCredentialsSession(android.accounts.AccountAuthenticatorResponse, android.accounts.Account, java.lang.String, android.os.Bundle).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to