AccountManager クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。
[Android.Runtime.Register("android/accounts/AccountManager", DoNotGenerateAcw=true)]
public class AccountManager : Java.Lang.Object
[<Android.Runtime.Register("android/accounts/AccountManager", DoNotGenerateAcw=true)>]
type AccountManager = class
inherit Object
- 継承
- 属性
注釈
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 ユーザーはアカウントごとに 1 回資格情報 (ユーザー名とパスワード) を入力し、アプリケーションに "ワンクリック" 承認でオンライン リソースへのアクセスを許可します。
オンライン サービスによってアカウントと認証の処理方法が異なるので、アカウント マネージャーは、<em>account の種類</em>ごとにプラグ可能な <em>authenticator</em> モジュールを使用します。 認証子 (サード パーティによって記述される可能性があります) は、アカウント資格情報の検証とアカウント情報の格納の実際の詳細を処理します。 たとえば、Google、Facebook、Microsoft Exchangeには、それぞれ独自の認証子があります。
多くのサーバーは、 <em>認証トークン</em>の概念をサポートしています。これは、ユーザーの実際のパスワードを送信せずにサーバーに要求を認証するために使用できます。 (認証トークンは通常、ユーザーの資格情報を含む別の要求で作成されます)。AccountManager はアプリケーションの認証トークンを生成できるため、アプリケーションでパスワードを直接処理する必要はありません。 認証トークンは通常、再利用可能であり、AccountManager によってキャッシュされますが、定期的に更新する必要があります。 アプリケーションが動作を停止したときに認証トークンを <em>invalidate</em> する必要があるため、AccountManager はトークンを再生成する必要があることを認識します。
通常、サーバーにアクセスするアプリケーションは、次の手順を実行します。
<ul><li>#get(Context) を使用して AccountManager のインスタンスを取得します。
<li>#getAccountsByType または #getAccountsByTypeAndFeatures を使用して使用可能なアカウントを一覧に登録します。 通常、アプリケーションは、認証子を識別する 1 つの特定の <em>type</em> を持つアカウントにのみ関心があります。 Account <em>features</em> は、特定のアカウント サブタイプと機能を識別するために使用されます。 アカウントの種類と機能はどちらも認証子固有の文字列であり、アプリケーションが優先する認証子と連携して認識する必要があります。
<li>ユーザーに希望を求めることにより、使用可能なアカウントを 1 つ以上選択します。 適切なアカウントが使用できない場合は、 #addAccount を呼び出して、適切な種類のアカウントを作成するようユーザーに求めるメッセージを表示できます。
<li><b>Important:</b> アプリケーションが以前に記憶したアカウントの選択を使用している場合は、アカウントが #getAccountsByTypeによって返されたアカウントの一覧に残っていることを確認する必要があります。 デバイスでアカウントの認証トークンを要求すると、未定義のエラーが発生しなくなりました。
<li>#getAuthToken メソッドまたは関連するヘルパーのいずれかを使用して、選択したアカウントの認証トークンを要求します。 正確な使用法とエラー処理の詳細については、各方法の説明を参照してください。
<li>認証トークンを使用して要求を作成します。 認証トークンの形式、要求の形式、使用されるプロトコルはすべて、アクセスするサービスに固有です。 アプリケーションは、便利なネットワーク ライブラリとプロトコル ライブラリを使用できます。
<li><b>Important:</b> 認証エラーで要求が失敗した場合、キャッシュされた認証トークンが古く、サーバーによって受け入れられなくなった可能性があります。 アプリケーションはキャッシュからトークンを削除するために #invalidateAuthToken を呼び出す必要があります。そうしないと、要求は失敗し続けます。 認証トークンを無効にした後、直ちに上記の「認証トークンを要求する」の手順に戻ります。 2 回目にプロセスが失敗した場合は、"正規の" 認証エラーとして扱われ、ユーザーに通知またはその他の適切なアクションが実行されます。
</ul>
一部の AccountManager メソッドでは、資格情報の入力を求めたり、オプションを提示したり、ユーザーにアカウントの追加を求めたりするために、ユーザーと対話することが必要になる場合があります。 呼び出し元は、AccountManager が必要なユーザー インターフェイスを直接起動してユーザーを待機するか、呼び出し元がインターフェイスの起動に使用できる意図を返すか、(場合によっては) ユーザーがいつでも選択してインターフェイスを起動できる通知をインストールするかを選択できます。 AccountManager でインターフェイスを直接起動させるには、呼び出し元が現在のフォアグラウンド Activity コンテキストを指定する必要があります。
多くの AccountManager メソッドは、パラメーターとして AccountManagerCallback と Handler を受け取ります。 これらのメソッドはすぐに返され、非同期的に実行されます。 コールバックが指定された場合、要求が正常に完了した場合、または完了しなかったときに、ハンドラーのスレッドで AccountManagerCallback#run が呼び出されます。 結果は、メソッドによって返されたAccountManagerFuture#getResult()に対してAccountManagerFutureを呼び出すことによって取得されます (コールバックにも渡されます)。 このメソッドは、操作が完了するまで待機し (必要な場合)、結果を返すか、操作中にエラーが発生した場合に例外をスローします。 要求を同期的に行うには、メソッドから将来を受信した直後に AccountManagerFuture#getResult() を呼び出します。コールバックを指定する必要はありません。
AccountManagerFuture#getResult()を含め、ブロックする可能性がある要求は、アプリケーションのメイン イベント スレッドで呼び出してはなりません。 これらの操作は、メイン スレッドで使用されている場合に IllegalStateException をスローします。
このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。
コンストラクター
| Name | 説明 |
|---|---|
| AccountManager(IntPtr, JniHandleOwnership) |
JNI オブジェクトのマネージド表現を作成するときに使用されるコンストラクター。ランタイムによって呼び出されます。 |
フィールド
| Name | 説明 |
|---|---|
| ActionAccountRemoved |
アカウントが削除または名前変更されたときに、AccountsService によってブロードキャストインテントとして送信されるアクション。 |
| ActionAuthenticatorIntent | |
| AuthenticatorAttributesName | |
| AuthenticatorMetaDataName | |
| ErrorCodeBadArguments | |
| ErrorCodeBadAuthentication | |
| ErrorCodeBadRequest | |
| ErrorCodeCanceled | |
| ErrorCodeInvalidResponse | |
| ErrorCodeNetworkError | |
| ErrorCodeRemoteException | |
| ErrorCodeUnsupportedOperation | |
| KeyAccountAuthenticatorResponse | |
| KeyAccountManagerResponse | |
| KeyAccountName |
特定のアカウントに関する情報を返すメソッドの結果として、 |
| KeyAccounts | |
| KeyAccountSessionBundle |
|
| KeyAccountStatusToken |
特定のアカウントに関する情報を返す |
| KeyAccountType |
特定のアカウントに関する情報を返すメソッドの結果として、 |
| KeyAndroidPackageName |
呼び出し元の Android パッケージは、 |
| KeyAuthenticatorTypes | |
| KeyAuthFailedMessage | |
| KeyAuthtoken |
|
| KeyAuthTokenLabel | |
| KeyBooleanResult | |
| KeyCallerPid |
呼び出し元アプリのプロセス ID。 |
| KeyCallerUid |
呼び出し元アプリの UID。 |
| KeyErrorCode | |
| KeyErrorMessage | |
| KeyIntent |
呼び出し元がユーザーとの対話を必要とする可能性があるメソッドの結果として、 |
| KeyLastAuthenticatedTime |
アカウントの資格情報が最後に正常に認証された時刻を指定するために使用されるバンドル キー。 |
| KeyPassword |
標準のパスワード プロンプトをユーザーに求めるのではなく、 |
| KeyUserdata | |
| LoginAccountsChangedAction |
アカウントが追加されたとき、アカウントが削除されたとき、またはアカウントの資格情報 (保存されたパスワードなど) が変更されたときに、AccountsService によってブロードキャストインテントとして送信されるアクション。 |
| PackageNameKeyLegacyNotVisible |
|
| PackageNameKeyLegacyVisible |
次のいずれかの条件を満たすアプリケーションの可視性を設定するためのキー: <ul><li>ターゲット API レベルが |
プロパティ
| Name | 説明 |
|---|---|
| Class |
この |
| Handle |
基になる Android インスタンスへのハンドル。 (継承元 Object) |
| JniIdentityHashCode |
相互運用ランタイムによってこのJava ピアに割り当てられた ID ハッシュ コードを取得します。 (継承元 Object) |
| JniManagedPeerState |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| JniPeerMembers |
この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 |
| PeerReference |
このJava ピアの JNI オブジェクト参照を取得します。 (継承元 Object) |
| ThresholdClass |
この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 |
| ThresholdType |
この API は Android 用 Mono インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 |
メソッド
| Name | 説明 |
|---|---|
| AddAccount(String, String, String[], Bundle, Activity, IAccountManagerCallback, Handler) |
指定した種類のアカウントを追加するようにユーザーに求めます。 |
| AddAccountExplicitly(Account, String, Bundle, IDictionary<String,Integer>) |
AccountManager に直接アカウントを追加します。 |
| AddAccountExplicitly(Account, String, Bundle) |
AccountManager に直接アカウントを追加します。 |
| AddOnAccountsUpdatedListener(IOnAccountsUpdateListener, Handler, Boolean, String[]) |
|
| AddOnAccountsUpdatedListener(IOnAccountsUpdateListener, Handler, Boolean) |
|
| BlockingGetAuthToken(Account, String, Boolean) |
この便利なヘルパーは、 |
| ClearPassword(Account) |
保存されたパスワードを忘れた場合。 |
| Clone() |
このオブジェクトのコピーを作成して返します。 (継承元 Object) |
| ConfirmCredentials(Account, Bundle, Activity, IAccountManagerCallback, Handler) |
ユーザーがアカウントのパスワードを知っていることを確認し、アカウントの所有者であることを確認します。 |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| Dispose() |
このJava ピアによって保持されているリソースを解放します。 (継承元 Object) |
| Dispose(Boolean) |
このJava ピアによって保持されているリソースを解放します。 (継承元 Object) |
| DisposeUnlessReferenced() |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| EditProperties(String, Activity, IAccountManagerCallback, Handler) |
ユーザーに認証子の設定を変更する機会を提供します。 |
| Equals(Object) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| Equals(Object) |
他のオブジェクトがこのオブジェクトと "等しい" かどうかを示します。 (継承元 Object) |
| FinishSession(Bundle, Activity, IAccountManagerCallback, Handler) |
|
| FromContext(Context) |
コンテキストに関連付けられているアカウント マネージャー インスタンスを取得します。 |
| Get(Context) |
コンテキストに関連付けられている AccountManager インスタンスを取得します。 |
| GetAccounts() |
種類に関係なく、呼び出し元に表示されるすべてのアカウントを一覧表示します。 |
| GetAccountsAndVisibilityForPackage(String, String) |
特定の種類のすべてのアカウントと、特定のパッケージの可視性を取得します。 |
| GetAccountsByType(String) |
呼び出し元に表示される特定の種類のすべてのアカウントを一覧表示します。 |
| GetAccountsByTypeAndFeatures(String, String[], IAccountManagerCallback, Handler) |
特定の機能を持つ種類のすべてのアカウントを一覧表示します。 |
| GetAccountsByTypeForPackage(String, String) |
一部のアプリがすべてのアカウントを表示する権限を持たない環境で、指定されたパッケージに表示されるアカウントを返します。 |
| GetAccountVisibility(Account, String) |
特定のアプリケーションの特定のアカウントの可視性を取得します。 |
| GetAuthenticatorTypes() |
現在登録されている認証子を一覧表示します。 |
| GetAuthToken(Account, String, Boolean, IAccountManagerCallback, Handler) |
古い.
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。 |
| GetAuthToken(Account, String, Bundle, Activity, IAccountManagerCallback, Handler) |
特定のアカウントに対して指定した種類の認証トークンを取得し、必要に応じてユーザーに資格情報の入力を求めます。 |
| GetAuthToken(Account, String, Bundle, Boolean, IAccountManagerCallback, Handler) |
特定のアカウントの指定した種類の認証トークンを取得します。必要に応じて、ユーザーが資格情報を入力する必要がある場合は通知を生成します。 |
| GetAuthTokenByFeatures(String, String, String[], Activity, Bundle, Bundle, IAccountManagerCallback, Handler) |
この便利なヘルパーは、 |
| GetHashCode() |
オブジェクトのハッシュ コード値を返します。 (継承元 Object) |
| GetPackagesAndVisibilityForAccount(Account) |
指定されたアカウントに対して明示的に設定されたパッケージ名と可視性を返します。 |
| GetPassword(Account) |
アカウントに関連付けられている保存されたパスワードを取得します。 |
| GetPreviousName(Account) |
アカウントに関連付けられている以前の名前を取得するか、 |
| GetUserData(Account, String) |
アカウントに関連付けられた "キー" によって名前付けされたユーザー データを取得します。 |
| HasFeatures(Account, String[], IAccountManagerCallback, Handler) |
特定のアカウントに指定されたすべての機能があるかどうかを確認します。 |
| InvalidateAuthToken(String, String) |
AccountManager のキャッシュから認証トークンを削除します。 |
| IsCredentialsUpdateSuggested(Account, String, IAccountManagerCallback, Handler) |
指定したアカウントに対して |
| JavaFinalize() |
古い.
オブジェクトへの参照がなくなったとガベージ コレクションによって判断されたときに、オブジェクトのガベージ コレクターによって呼び出されます。 (継承元 Object) |
| NewChooseAccountIntent(Account, IList<Account>, String[], Boolean, String, String, String[], Bundle) |
古い.
|
| NewChooseAccountIntent(Account, IList<Account>, String[], String, String, String[], Bundle) |
アカウントの一覧から選択するようにユーザーに求める意図を |
| Notify() |
このオブジェクトのモニターで待機している 1 つのスレッドを起動します。 (継承元 Object) |
| NotifyAccountAuthenticated(Account) |
アカウントが認証されたばかりであることをシステムに通知します。 |
| NotifyAll() |
このオブジェクトのモニターで待機しているすべてのスレッドを起動します。 (継承元 Object) |
| PeekAuthToken(Account, String) |
AccountManager のキャッシュから認証トークンを取得します。 |
| RemoveAccount(Account, Activity, IAccountManagerCallback, Handler) |
AccountManager からアカウントを削除します。 |
| RemoveAccount(Account, IAccountManagerCallback, Handler) |
古い.
AccountManager からアカウントを削除します。 |
| RemoveAccountExplicitly(Account) |
アカウントを直接削除します。 |
| RemoveOnAccountsUpdatedListener(IOnAccountsUpdateListener) |
以前に |
| RenameAccount(Account, String, IAccountManagerCallback, Handler) |
指定した |
| SetAccountVisibility(Account, String, AccountVisibility) |
特定のアカウントの可視性の値を特定のパッケージに設定します。 |
| SetAuthToken(Account, String, String) |
アカウントの AccountManager キャッシュに認証トークンを追加します。 |
| SetHandle(IntPtr, JniHandleOwnership) |
Handle プロパティを設定します。 (継承元 Object) |
| SetPassword(Account, String) |
保存したパスワードを設定または削除します。 |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| SetUserData(Account, String, String) |
アカウントのユーザー データ キーを 1 つ設定します。 |
| StartAddAccountSession(String, String, String[], Bundle, Activity, IAccountManagerCallback, Handler) |
指定した種類のアカウントで認証するようにユーザーに求めます。 |
| StartUpdateCredentialsSession(Account, String, Bundle, Activity, IAccountManagerCallback, Handler) |
ユーザーに、アカウントの新しいパスワードを入力するように求めますが、 |
| ToArray<T>() |
このJava配列ラッパーからマネージド配列を作成します。 (継承元 Object) |
| ToString() |
オブジェクトの文字列形式を返します。 (継承元 Object) |
| UnregisterFromRuntime() |
相互運用ランタイムからこのJava ピアの登録を解除します。 (継承元 Object) |
| UpdateCredentials(Account, String, Bundle, Activity, IAccountManagerCallback, Handler) |
アカウントの新しいパスワードの入力をユーザーに求め、アカウントの保存された資格情報を更新します。 |
| Wait() |
現在のスレッドが起動するまで待機します。通常は、 <em>notified</em> または <em>interrupted</em>。 (継承元 Object) |
| Wait(Int64, Int32) |
現在のスレッドは、通常、 <em>notified</em> または <em>interrupted</em>、または一定のリアルタイムが経過するまで、起動されるまで待機します。 (継承元 Object) |
| Wait(Int64) |
現在のスレッドは、通常、 <em>notified</em> または <em>interrupted</em>、または一定のリアルタイムが経過するまで、起動されるまで待機します。 (継承元 Object) |
イベント
| Name | 説明 |
|---|---|
| AccountsUpdated |
アカウント マネージャーが起動し、アカウントのセットが変更されるたびに発生します。 |
明示的なインターフェイスの実装
| Name | 説明 |
|---|---|
| IJavaPeerable.Disposed() |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| IJavaPeerable.Finalized() |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 (継承元 JavaObject) |
拡張メソッド
| Name | 説明 |
|---|---|
| GetJniTypeName(IJavaPeerable) |
インスタンス |
| JavaAs<TResult>(IJavaPeerable) |
|
| JavaCast<TResult>(IJavaObject) |
Android ランタイムチェック型変換を実行します。 |
| JavaCast<TResult>(IJavaObject) |
このクラスは、ユーザーのオンライン アカウントの一元化されたレジストリへのアクセスを提供します。 |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
|