Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDK
/
Java SDK
/
API リファレンス
/
io.realm.mongodb

クラスユーザー

項目一覧

  • io.realm.mongodb
  • ネストされたクラスの概要
  • メソッドの概要
  • 継承されたメソッド
  • メソッドの詳細
  • equals
  • getAccessToken
  • getApiKeys
  • getApp
  • getCustomData
  • getDeviceId
  • getFunctions
  • getId
  • getIdentity
  • getMongoClient
  • getProfile
  • getProviderType
  • getPussh
  • getRefreshToken
  • getState
  • ハッシュコード
  • isLoggedIn
  • linkCredentials
  • linkCredentialsAsync
  • logOut
  • logOutAsync
  • refreshCustomData
  • delete
  • deleteAsync

io.realm.mongodb

java.lang.Object
io.realm.mongodb.User

ユーザー は、Realm App 機能にアクセスするためのユーザーのメタデータとトークンを保持します。ユーザーは同期された Realm の構成に使用され、 関数 を介して Realm App Function を呼び出し、リモート Realm App にアクセスします。

mongoMongoClient を通じて データベース 。

Tip

以下も参照してください。

  • App.login(Credentials)

  • io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(ユーザー,string)

ネストされたクラスの概要

修飾子と型
クラスと説明
public static final

メソッドの概要

修飾子と型
メソッドと説明
パブリックブール値
equals (
Object o
)

同じユーザー ID を持ち、同じアプリに関連付けられている場合、2 人のユーザーは等しいと見なされます。

public string
getAccessToken ()

ユーザーの現在のアクセス トークンを返します。

公開同期ApiKeyAuth
getApiKeys ()

現在のユーザーが制御している API キーを管理するためのラッパーを返します。

public App
getApp ()

このユーザーが関連付けられているアプリを返します。

public Document
getCustomData ()

Realm App 内のユーザーに関連付けられているカスタム ユーザー データを返します。

public string
getDeviceId ()

ユーザーがログインしたデバイスの一意の識別子を返します。

public Functions
getFunctions (
CodecRegistry codecRegistry
)

引数と結果をエンコードおよびデコードするためのカスタム コーデック レジストリを使用して Realm 関数を呼び出すための関数マネージャーを返します。

public synchronized Functions
getFunctions ()

MongoDB Realm Function を呼び出すための関数マネージャーを返します。

public string
getId ()

ユーザーのサーバー ID を返します。

public list
getIdentities ()

ユーザーの ID の新しいリストを返します。

公開同期MongoClient
getMongoClient (
String serviceName
)

データベース内のドキュメントにアクセスするためのMongoClientインスタンスを返します。

getProfile ()

このユーザーのプロファイルを返します。

getProviderType ()

ユーザーのログ記録に使用されるプロバイダーの種類を返します

public synchronized Push
getPush (
String serviceName
)

プッシュ通知登録を管理するためのプッシュインスタンスを返します。

public string
getRefreshToken ()

ユーザーの現在の更新トークンを返します。

public User.State
getState ()

ユーザーの状態を返します。

public int
パブリックブール値
isLoggedIn ()

ユーザーが現在ログインしている場合は true を返します。

linkCredentials (
Credentials credentials
)

現在のユーザーを、指定された認証情報で表される新しいユーザー ID にリンクします。

linkCredentialsAsync (
Credentials credentials,
io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback
)

現在のユーザーを、指定された認証情報で表される新しいユーザー ID にリンクします。

public void
logOut ()

ユーザーを Realm App からログアウトします。

logOutAsync (
io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback
)

Realm Appから非同期にユーザーをログアウトします。

refreshCustomData (
io.realm.mongodb.App.Callback<Document> callback
)

Realm App から非同期にカスタム ユーザー データを再取得します。

public Document
refreshCustomData ()

Realm App からカスタム ユーザー データを再取得します。

remove ()

これを呼び出すと、ユーザーとユーザーが持つすべての Realm がデバイスから削除されます。

removeAsync (
io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback
)

これを呼び出すと、ユーザーとユーザーが持つすべての Realm がデバイスから非同期に削除されます。

継承されたメソッド

  • クラス java.lang.Object から継承されたメソッド :getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

メソッドの詳細

equals

public boolean equals (
Object o
)

同じユーザー ID を持ち、同じアプリに関連付けられている場合、2 人のユーザーは等しいと見なされます。

の上書き

equals クラス オブジェクト 内

getAccessToken

ユーザーの現在のアクセス トークンを返します。

戻り値

現在のアクセス トークン。

getApiKeys

public synchronized ApiKeyAuth getApiKeys ()

現在のユーザーが制御している API キーを管理するためのラッパーを返します。

戻り値

現在のユーザーが制御する API キーを管理するためのラッパー。

スロー

getApp

public App getApp ()

このユーザーが関連付けられているアプリを返します。

戻り値

このユーザーが関連付けられているアプリ。

getCustomData

public Document getCustomData ()

Realm アプリのユーザーに関連付けられているカスタム ユーザー データを返します。データは、ユーザーのアクセス トークンが更新された場合、またはrefreshCustomData()を明示的に呼び出した場合にのみ更新されます。

戻り値

ユーザーに関連付けられているカスタム ユーザー データ。

getDeviceId

ユーザーがログインしたデバイスの一意の識別子を返します。

戻り値

ユーザーの一意のデバイス識別子。

getFunctions

public Functions getFunctions (
CodecRegistry codecRegistry
)

引数と結果をエンコードおよびデコードするためのカスタム コーデック レジストリを使用して Realm 関数を呼び出すための関数マネージャーを返します。

パラメーター

  • codecRegistry - リモート Realm アプリへの引数と結果のエンコードとデコードに使用するコーデック レジストリ。

Tip

以下も参照してください。

public synchronized Functions getFunctions ()

MongoDB Realm 関数を呼び出すための関数マネージャーを返します。これにより、関連付けられたアプリのデフォルトのコーデック レジストリを使用して、引数と結果をエンコードおよびデコードします。

Tip

以下も参照してください。

getId

public String getId ()

ユーザーのサーバー ID を返します。

戻り値

ユーザーのサーバー ID。

getIdentity

ユーザーの ID の新しいリストを返します。

戻り値

ID のリスト。

Tip

以下も参照してください。

getMongoClient

public synchronized MongoClient getMongoClient (
String serviceName
)

データベース内のドキュメントにアクセスするためのMongoClientインスタンスを返します。

パラメーター

  • serviceName - サーバーに接続するために使用されるサービス名。

getProfile

このユーザーのプロファイルを返します。

戻り値

このユーザーの プロファイル

getProviderType

ユーザーのログ記録に使用されるプロバイダーの種類を返します

戻り値

ユーザーの プロバイダーの種類

getPussh

public synchronized Push getPush (
String serviceName
)

プッシュ通知登録を管理するためのプッシュインスタンスを返します。

パラメーター

  • serviceName - サーバーに接続するために使用されるサービス名。

getRefreshToken

ユーザーの現在の更新トークンを返します。

戻り値

現在のリフレッシュ トークン。

getState

ユーザーの状態を返します。

戻り値

ユーザーの状態。

ハッシュコード

public int hashCode ()

isLoggedIn

public boolean isLoggedIn ()

ユーザーが現在ログインしている場合は true を返します。 このユーザーがまだ MongoDB Realm アプリにログインしているかどうかを返します。

戻り値

true まだログインしている場合は 、ログインしていない場合はfalse 。

linkCredentials

public User linkCredentials (
Credentials credentials
)

現在のユーザーを、指定された認証情報で表される新しいユーザー ID にリンクします。より多くの認証情報を持つユーザーをリンクすると、ユーザーはこれらの認証情報のいずれかでログインできるようになります。 また、 を とリンクすると、匿名ユーザーを「アップグレード」することもできます。 メール/パスワードの認証情報。

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

注：MongoDB Realm の既存のユーザー 2 人のユーザーをリンクすることはできません。 提供された認証情報は、別のユーザーによって使用されてはなりません。

パラメーター

  • credentials - 現在のユーザーにリンクする認証情報。

戻り値

認証情報がリンクされたユーザー

スロー

linkCredentialsAsync

現在のユーザーを、指定された認証情報で表される新しいユーザー ID にリンクします。より多くの認証情報を持つユーザーをリンクすると、ユーザーはこれらの認証情報のいずれかでログインできるようになります。 また、 を とリンクすると、匿名ユーザーを「アップグレード」することもできます。 メール/パスワードの認証情報。

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

注：MongoDB Realm の既存のユーザー 2 人のユーザーをリンクすることはできません。 提供された認証情報は、別のユーザーによって使用されてはなりません。

パラメーター

  • credentials - 現在のユーザーにリンクする認証情報。

  • callback - ユーザー ID がリンクされているか、失敗した場合のコールバック。 コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。

スロー

logOut

public void logOut ()

ユーザーを Realm App からログアウトします。 これにより、デバイスへの登録が解除され、ユーザーの Realm との間の同期が停止します。 ユーザーが所有する Realm は、 User.remove()が呼び出される前に、デバイスから削除されません。

Realm Appがログアウトを確認すると、登録されているすべてのAuthenticationListnerに通知が行われ、ユーザー認証情報はこのデバイスから削除されます。

匿名ユーザーをログアウトすると、ユーザー.State.LOGGED_OUTとしてマークされる代わりに、それらはすぐに削除されます。

他のすべてのユーザーは ユーザー.State.LOGGED_OUTとしてマークされ、 App.allUsers()によって引き続き返されます。 ユーザー.remove()を呼び出すと、完全に削除できます。

スロー

  • AppException - Realm Appからユーザーをログアウトしようとしたときにエラーが発生した場合。

logOutAsync

Realm Appから非同期にユーザーをログアウトします。 これにより、デバイスへの登録が解除され、ユーザーの Realm との間の同期が停止します。 ユーザーが所有する Realm は、 User.remove()が呼び出される前に、デバイスから削除されません。

Realm Appがログアウトを確認すると、登録されているすべてのAuthenticationListnerに通知が行われ、ユーザー認証情報はこのデバイスから削除されます。

匿名ユーザーをログアウトすると、ユーザー.State.LOGGED_OUTとしてマークされる代わりに、それらはすぐに削除されます。

他のすべてのユーザーは ユーザー.State.LOGGED_OUTとしてマークされ、 App.allUsers()によって引き続き返されます。 ユーザー.remove()を呼び出すと、完全に削除できます。

パラメーター

  • callback - ログアウトが完了または失敗したときのコールバック。 コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。

スロー

refreshCustomData

Realm App から非同期にカスタム ユーザー データを再取得します。これはrefreshCustomData()の非同期バリアントです。

パラメーター

  • callback - リクエストからの結果またはエラーを受け取るコールバック。

戻り値

実行中の操作を表すタスク。

スロー

public Document refreshCustomData ()

Realm App からカスタム ユーザー データを再取得します。

戻り値

ユーザーに関連付けられている更新されたカスタム ユーザー データ。

スロー

  • AppException - リクエストが何らかの方法で失敗した場合。

delete

public User remove ()

これを呼び出すと、ユーザーとユーザーが持つすべての Realm がデバイスから削除されます。 サーバーからデータは削除されません。 このメソッドを呼び出すときにユーザーがログインしている場合、データが削除される前にユーザーはログアウトされます。

戻り値

削除されたユーザーを参照してください。

スロー

  • AppException - ユーザーを削除しようとしたときにエラーが発生した場合。

deleteAsync

これを呼び出すと、ユーザーとユーザーが持つすべての Realm がデバイスから非同期に削除されます。 サーバーからデータは削除されません。 このメソッドを呼び出すときにユーザーがログインしている場合、データが削除される前にユーザーはログアウトされます。

パラメーター

  • callback - ユーザーが完了または失敗したことを削除するときのコールバック。 コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。

スロー

戻る

RealmResultTask

次へ

ユーザー.State