AccountManager.GetAuthToken メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| Name | 説明 |
|---|---|
| GetAuthToken(Account, String, Boolean, IAccountManagerCallback, Handler) |
古い.
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。 |
| GetAuthToken(Account, String, Bundle, Activity, IAccountManagerCallback, Handler) |
特定のアカウントに対して指定した種類の認証トークンを取得し、必要に応じてユーザーに資格情報の入力を求めます。 |
| GetAuthToken(Account, String, Bundle, Boolean, IAccountManagerCallback, Handler) |
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。 |
GetAuthToken(Account, String, Boolean, IAccountManagerCallback, Handler)
注意事項
deprecated
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。
[Android.Runtime.Register("getAuthToken", "(Landroid/accounts/Account;Ljava/lang/String;ZLandroid/accounts/AccountManagerCallback;Landroid/os/Handler;)Landroid/accounts/AccountManagerFuture;", "GetGetAuthToken_Landroid_accounts_Account_Ljava_lang_String_ZLandroid_accounts_AccountManagerCallback_Landroid_os_Handler_Handler")]
[Android.Runtime.RequiresPermission("android.permission.USE_CREDENTIALS")]
[System.Obsolete("deprecated")]
public virtual Android.Accounts.IAccountManagerFuture? GetAuthToken(Android.Accounts.Account? account, string? authTokenType, bool notifyAuthFailure, Android.Accounts.IAccountManagerCallback? callback, Android.OS.Handler? handler);
[<Android.Runtime.Register("getAuthToken", "(Landroid/accounts/Account;Ljava/lang/String;ZLandroid/accounts/AccountManagerCallback;Landroid/os/Handler;)Landroid/accounts/AccountManagerFuture;", "GetGetAuthToken_Landroid_accounts_Account_Ljava_lang_String_ZLandroid_accounts_AccountManagerCallback_Landroid_os_Handler_Handler")>]
[<Android.Runtime.RequiresPermission("android.permission.USE_CREDENTIALS")>]
[<System.Obsolete("deprecated")>]
abstract member GetAuthToken : Android.Accounts.Account * string * bool * Android.Accounts.IAccountManagerCallback * Android.OS.Handler -> Android.Accounts.IAccountManagerFuture
override this.GetAuthToken : Android.Accounts.Account * string * bool * Android.Accounts.IAccountManagerCallback * Android.OS.Handler -> Android.Accounts.IAccountManagerFuture
パラメーター
- account
- Account
認証トークンをフェッチするアカウント
- authTokenType
- String
認証トークンの種類 (認証子に依存する文字列トークン) は null にすることはできません
- notifyAuthFailure
- Boolean
必要に応じてユーザーにパスワードの入力を求める通知を追加する場合は True、呼び出し元に残す場合は false
- callback
- IAccountManagerCallback
要求が完了したときに呼び出すコールバック。コールバックがない場合は null
- handler
- Handler
Handler コールバック スレッドの識別、メイン スレッドの場合は null
返品
成功した場合に少なくとも次のフィールドを持つバンドルに解決される AccountManagerFuture : <ul><li>#KEY_ACCOUNT_NAME - 指定したアカウントの名前 <li>#KEY_ACCOUNT_TYPE - アカウントの種類 <li>#KEY_AUTHTOKEN - 必要な認証トークン </ul>
(Other authenticator-specific values may be returned.) If the user
must enter credentials, the returned Bundle contains only
<code data-dev-comment-type="c">#KEY_INTENT</code> with the <code data-dev-comment-type="c">Intent</code> needed to launch a prompt.
If an error occurred, <code data-dev-comment-type="c">AccountManagerFuture#getResult()</code> throws:
<ul>
<li> <code data-dev-comment-type="c">AuthenticatorException</code> if the authenticator failed to respond
<li> <code data-dev-comment-type="c">OperationCanceledException</code> if the operation is canceled for
any reason, incluidng the user canceling a credential request
<li> <code data-dev-comment-type="c">IOException</code> if the authenticator experienced an I/O problem
creating a new auth token, usually because of network trouble
</ul>
If the account is no longer present on the device, the return value is
authenticator-dependent. The caller should verify the validity of the
account before requesting an auth token.
- 属性
注釈
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。 このメソッドは、ユーザーがパスワード プロンプトですぐに中断されないようにするバックグラウンド タスクとサービスを対象としています。
以前に生成された認証トークンがこのアカウントに対してキャッシュされ、入力されると、それが返されます。 それ以外の場合、保存されたパスワードが使用可能な場合は、新しい認証トークンを生成するためにサーバーに送信されます。 それ以外の場合は、 Intent が返され、起動時にユーザーにパスワードの入力を求められます。 notifyAuthFailure パラメーターが設定されている場合、ステータス バーの通知も同じ意図で作成され、ある時点でパスワードを入力する必要があることをユーザーに警告します。
その場合、ユーザーが応答するまで待つ必要がある場合があり、数時間または数日かかる場合があります。 ユーザーが応答して新しいパスワードを指定すると、アカウント マネージャーは #LOGIN_ACCOUNTS_CHANGED_ACTION インテントをブロードキャストし、再試行に使用できるアプリケーション OnAccountsUpdateListener 通知します。
notifyAuthFailure が設定されていない場合、ある時点で返されたインテントを起動するのはアプリケーションの責任です。 いずれの場合も、この呼び出しの結果はユーザーのアクションを待機しません。
一部の認証子には認証トークン <em>types</em> があり、その値は認証子に依存します。 一部のサービスでは、さまざまな種類のトークンを使用してさまざまな機能にアクセスします。たとえば、Google では、同じアカウントの Gmail と Google カレンダーにアクセスするために異なる認証トークンを使用します。
このメソッドは任意のスレッドから呼び出される可能性がありますが、返される AccountManagerFuture はメイン スレッドで使用しないでください。
このメンバーは非推奨です。 代わりに #getAuthToken(Account, String, android.os.Bundle, boolean, AccountManagerCallback, android.os.Handler) を使用する
このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。
適用対象
GetAuthToken(Account, String, Bundle, Activity, IAccountManagerCallback, Handler)
特定のアカウントに対して指定した種類の認証トークンを取得し、必要に応じてユーザーに資格情報の入力を求めます。
[Android.Runtime.Register("getAuthToken", "(Landroid/accounts/Account;Ljava/lang/String;Landroid/os/Bundle;Landroid/app/Activity;Landroid/accounts/AccountManagerCallback;Landroid/os/Handler;)Landroid/accounts/AccountManagerFuture;", "GetGetAuthToken_Landroid_accounts_Account_Ljava_lang_String_Landroid_os_Bundle_Landroid_app_Activity_Landroid_accounts_AccountManagerCallback_Landroid_os_Handler_Handler")]
[Android.Runtime.RequiresPermission("android.permission.USE_CREDENTIALS")]
public virtual Android.Accounts.IAccountManagerFuture? GetAuthToken(Android.Accounts.Account? account, string? authTokenType, Android.OS.Bundle? options, Android.App.Activity? activity, Android.Accounts.IAccountManagerCallback? callback, Android.OS.Handler? handler);
[<Android.Runtime.Register("getAuthToken", "(Landroid/accounts/Account;Ljava/lang/String;Landroid/os/Bundle;Landroid/app/Activity;Landroid/accounts/AccountManagerCallback;Landroid/os/Handler;)Landroid/accounts/AccountManagerFuture;", "GetGetAuthToken_Landroid_accounts_Account_Ljava_lang_String_Landroid_os_Bundle_Landroid_app_Activity_Landroid_accounts_AccountManagerCallback_Landroid_os_Handler_Handler")>]
[<Android.Runtime.RequiresPermission("android.permission.USE_CREDENTIALS")>]
abstract member GetAuthToken : Android.Accounts.Account * string * Android.OS.Bundle * Android.App.Activity * Android.Accounts.IAccountManagerCallback * Android.OS.Handler -> Android.Accounts.IAccountManagerFuture
override this.GetAuthToken : Android.Accounts.Account * string * Android.OS.Bundle * Android.App.Activity * Android.Accounts.IAccountManagerCallback * Android.OS.Handler -> Android.Accounts.IAccountManagerFuture
パラメーター
- account
- Account
認証トークンをフェッチするアカウント
- authTokenType
- String
認証トークンの種類 (認証子に依存する文字列トークン) は null にすることはできません
- options
- Bundle
要求の認証子固有のオプション (null または空の場合があります)
- activity
- Activity
必要に応じてユーザーにパスワードの入力を求める新しい認証子定義サブアクティビティを起動するために使用する Activity コンテキスト。startActivity()の呼び出しにのみ使用されます。null にすることはできません。
- callback
- IAccountManagerCallback
要求が完了したときに呼び出すコールバック。コールバックがない場合は null
- handler
- Handler
Handler コールバック スレッドの識別、メイン スレッドの場合は null
返品
少なくとも次のフィールドを持つバンドルに解決される AccountManagerFuture : <ul><li>#KEY_ACCOUNT_NAME - 指定したアカウントの名前 <li>#KEY_ACCOUNT_TYPE - アカウントの種類 <li>#KEY_AUTHTOKEN - </ul が必要な認証トークン>
(Other authenticator-specific values may be returned.) If an auth token
could not be fetched, <code data-dev-comment-type="c">AccountManagerFuture#getResult()</code> throws:
<ul>
<li> <code data-dev-comment-type="c">AuthenticatorException</code> if the authenticator failed to respond
<li> <code data-dev-comment-type="c">OperationCanceledException</code> if the operation is canceled for
any reason, incluidng the user canceling a credential request
<li> <code data-dev-comment-type="c">IOException</code> if the authenticator experienced an I/O problem
creating a new auth token, usually because of network trouble
</ul>
If the account is no longer present on the device, the return value is
authenticator-dependent. The caller should verify the validity of the
account before requesting an auth token.
- 属性
注釈
特定のアカウントに対して指定した種類の認証トークンを取得し、必要に応じてユーザーに資格情報の入力を求めます。 このメソッドは、フォアグラウンドで実行されているアプリケーションを対象としています。この場合、ユーザーに直接パスワードを要求するのが理にかなっています。
以前に生成された認証トークンがこのアカウントに対してキャッシュされ、入力されると、それが返されます。 それ以外の場合、保存されたパスワードが使用可能な場合は、新しい認証トークンを生成するためにサーバーに送信されます。 それ以外の場合、ユーザーはパスワードの入力を求められます。
一部の認証子には認証トークン <em>types</em> があり、その値は認証子に依存します。 一部のサービスでは、さまざまな種類のトークンを使用してさまざまな機能にアクセスします。たとえば、Google では、同じアカウントの Gmail と Google カレンダーにアクセスするために異なる認証トークンを使用します。
<b>NOTE:</b> API レベル 22 以前でアプリを動作させる場合は、それらのプラットフォームにUSE_CREDENTIALSアクセス許可が必要です。 API レベル 22 のこの関数のドキュメントを参照してください。
このメソッドは任意のスレッドから呼び出される可能性がありますが、返される AccountManagerFuture はメイン スレッドで使用しないでください。
このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。
適用対象
GetAuthToken(Account, String, Bundle, Boolean, IAccountManagerCallback, Handler)
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。
[Android.Runtime.Register("getAuthToken", "(Landroid/accounts/Account;Ljava/lang/String;Landroid/os/Bundle;ZLandroid/accounts/AccountManagerCallback;Landroid/os/Handler;)Landroid/accounts/AccountManagerFuture;", "GetGetAuthToken_Landroid_accounts_Account_Ljava_lang_String_Landroid_os_Bundle_ZLandroid_accounts_AccountManagerCallback_Landroid_os_Handler_Handler")]
[Android.Runtime.RequiresPermission("android.permission.USE_CREDENTIALS")]
public virtual Android.Accounts.IAccountManagerFuture? GetAuthToken(Android.Accounts.Account? account, string? authTokenType, Android.OS.Bundle? options, bool notifyAuthFailure, Android.Accounts.IAccountManagerCallback? callback, Android.OS.Handler? handler);
[<Android.Runtime.Register("getAuthToken", "(Landroid/accounts/Account;Ljava/lang/String;Landroid/os/Bundle;ZLandroid/accounts/AccountManagerCallback;Landroid/os/Handler;)Landroid/accounts/AccountManagerFuture;", "GetGetAuthToken_Landroid_accounts_Account_Ljava_lang_String_Landroid_os_Bundle_ZLandroid_accounts_AccountManagerCallback_Landroid_os_Handler_Handler")>]
[<Android.Runtime.RequiresPermission("android.permission.USE_CREDENTIALS")>]
abstract member GetAuthToken : Android.Accounts.Account * string * Android.OS.Bundle * bool * Android.Accounts.IAccountManagerCallback * Android.OS.Handler -> Android.Accounts.IAccountManagerFuture
override this.GetAuthToken : Android.Accounts.Account * string * Android.OS.Bundle * bool * Android.Accounts.IAccountManagerCallback * Android.OS.Handler -> Android.Accounts.IAccountManagerFuture
パラメーター
- account
- Account
認証トークンをフェッチするアカウント
- authTokenType
- String
認証トークンの種類 (認証子に依存する文字列トークン) は null にすることはできません
- options
- Bundle
要求の認証子固有のオプション (null または空の場合があります)
- notifyAuthFailure
- Boolean
必要に応じてユーザーにパスワードの入力を求める通知を追加する場合は True、呼び出し元に残す場合は false
- callback
- IAccountManagerCallback
要求が完了したときに呼び出すコールバック。コールバックがない場合は null
- handler
- Handler
Handler コールバック スレッドの識別、メイン スレッドの場合は null
返品
成功した場合に少なくとも次のフィールドを持つバンドルに解決される AccountManagerFuture : <ul><li>#KEY_ACCOUNT_NAME - 指定したアカウントの名前 <li>#KEY_ACCOUNT_TYPE - アカウントの種類 <li>#KEY_AUTHTOKEN - 必要な認証トークン </ul>
(Other authenticator-specific values may be returned.) If the user
must enter credentials, the returned Bundle contains only
<code data-dev-comment-type="c">#KEY_INTENT</code> with the <code data-dev-comment-type="c">Intent</code> needed to launch a prompt.
If an error occurred, <code data-dev-comment-type="c">AccountManagerFuture#getResult()</code> throws:
<ul>
<li> <code data-dev-comment-type="c">AuthenticatorException</code> if the authenticator failed to respond
<li> <code data-dev-comment-type="c">OperationCanceledException</code> if the operation is canceled for
any reason, incluidng the user canceling a credential request
<li> <code data-dev-comment-type="c">IOException</code> if the authenticator experienced an I/O problem
creating a new auth token, usually because of network trouble
</ul>
If the account is no longer present on the device, the return value is
authenticator-dependent. The caller should verify the validity of the
account before requesting an auth token.
- 属性
注釈
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。 このメソッドは、ユーザーがパスワード プロンプトですぐに中断されないようにするバックグラウンド タスクとサービスを対象としています。
以前に生成された認証トークンがこのアカウントに対してキャッシュされ、入力されると、それが返されます。 それ以外の場合、保存されたパスワードが使用可能な場合は、新しい認証トークンを生成するためにサーバーに送信されます。 それ以外の場合は、 Intent が返され、起動時にユーザーにパスワードの入力を求められます。 notifyAuthFailure パラメーターが設定されている場合、ステータス バーの通知も同じ意図で作成され、ある時点でパスワードを入力する必要があることをユーザーに警告します。
その場合、ユーザーが応答するまで待つ必要がある場合があり、数時間または数日かかる場合があります。 ユーザーが応答して新しいパスワードを指定すると、アカウント マネージャーは #LOGIN_ACCOUNTS_CHANGED_ACTION インテントをブロードキャストし、再試行に使用できるアプリケーション OnAccountsUpdateListener 通知します。
notifyAuthFailure が設定されていない場合、ある時点で返されたインテントを起動するのはアプリケーションの責任です。 いずれの場合も、この呼び出しの結果はユーザーのアクションを待機しません。
一部の認証子には認証トークン <em>types</em> があり、その値は認証子に依存します。 一部のサービスでは、さまざまな種類のトークンを使用してさまざまな機能にアクセスします。たとえば、Google では、同じアカウントの Gmail と Google カレンダーにアクセスするために異なる認証トークンを使用します。
このメソッドは任意のスレッドから呼び出される可能性がありますが、返される AccountManagerFuture はメイン スレッドで使用しないでください。
<b>NOTE:</b> API レベル 22 以前でアプリを動作させる場合は、それらのプラットフォームにUSE_CREDENTIALSアクセス許可が必要です。 API レベル 22 のこの関数のドキュメントを参照してください。
このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。