user

インターフェース user

ユーザーは、App Services および Device Sync 機能にアクセスするためのユーザーのメタデータとトークンを保持します。

ユーザー プロファイルとカスタム データには、拡張関数 ユーザー.profileAsBsonDocument ユーザー .customDataAsBsonDocument を使用してアクセスできます。

ユーザーは、 SyncConfiguration.Builderを使用して同期された Realm を構成するために使用されます。

次も参照してください

タイプ

クリップボードにコピーされたリンク

ユーザーの潜在的な状態。

プロパティ

クリップボードにコピーされたリンク
抽象 価値 accessToken: 文字列

ユーザーの現在のアクセス トークンを返します。 ユーザーがログアウトすると、空のアクセス トークンが返されます。

クリップボードにコピーされたリンク
抽象 価値 apiKeyAuth: ApiKeyAuth

ユーザーが API キーを管理できるように、 ApiKeyAuthインターフェースへのアクセス権を付与します。

クリップボードにコピーされたリンク
抽象 価値 アプリ: アプリ

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

クリップボードにコピーされたリンク
抽象 価値 DeviceId: 文字列

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

クリップボードにコピーされたリンク
抽象 価値 関数: 関数

App Services 関数を呼び出すためのラッパーを返します。

クリップボードにコピーされたリンク
抽象 価値 id: 文字列

ユーザーのサーバー ID。

クリップボードにコピーされたリンク

このユーザーに対して有効になっている認証プロバイダによって有効になっているユーザーの ID のリストを返します。

クリップボードにコピーされたリンク
抽象 価値 loggedIn: ブール値

このユーザーがまだ App Services アプリケーションにログインしているかどうかを返します。

クリップボードにコピーされたリンク
抽象 価値 refreshToken: 文字列

ユーザーの現在の更新トークンを返します。 ユーザーがログアウトした場合、空のリフレッシュ トークンが返されます。

クリップボードにコピーされたリンク
抽象 価値 状態: ユーザー.State

このユーザーが所属する状態

関数

クリップボードにコピーされたリンク
インライン fun <t> user.customData(シリアライザー: KSerializer < T > = (UserImpl として).app.configuration.ejson.serializersModule.serializerOrRealmBuildInSerializer()): t?

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

クリップボードにコピーされたリンク
インライン fun user.customDataAsBsonDocument(): BsonDocument?

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

クリップボードにコピーされたリンク
抽象 paused fun 削除()

は、Atlas App Services アプリからこのユーザーを完全に削除します。

クリップボードにコピーされたリンク
抽象 演算子オーバーライド fun equals(その他の:任意): ブール値

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

クリップボードにコピーされたリンク
抽象 paused fun linkCredentials(認証情報:認証情報): user

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

クリップボードにコピーされたリンク
抽象 paused fun logOut()

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

クリップボードにコピーされたリンク
@試験用KBsonSerializerApi
抽象 fun MongoClient(serviceName : string EJSON : EJSON ? = null): MongoClient

App Service の データソース からドキュメントにアクセスするための MongoClient を取得します。

クリップボードにコピーされたリンク
インライン fun <t> user.プロファイル(シリアライザー: KSerializer < T > = (UserImpl として).app.configuration.ejson.serializersModule.serializerOrRealmBuildInSerializer()): t

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

クリップボードにコピーされたリンク
インライン fun user.profileAsBsonDocument(): BsonDocument

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

クリップボードにコピーされたリンク
抽象 paused fun refreshCustomData()

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

クリップボードにコピーされたリンク
抽象 paused fun delete(): user

ユーザーとユーザーが持つすべての Realm をデバイスから削除します。 サーバーからデータは削除されません。