Realm Kotlin SDK - 동기화/io.realm.kotlin.mongodb/사용자

사용자

인터페이스 사용자

사용자 는 App Services 및 Realm Mobile Sync 기능에 액세스하기 위해 사용자의 메타데이터와 토큰을 보유합니다.

사용자 프로필 및 사용자 지정 데이터는 확장 함수 User.profileAsBsonDocument 및 User.customDataAsBsonDocument 를 사용하여 액세스할 수 있습니다.

사용자는 SyncConfiguration.Builder 를 사용하여 동기화된 영역을 구성하는 데 사용됩니다.

다음의 사항도 참조하세요.

유형

클립보드에 링크 복사됨
열거형 State : 열거형<User.State>

사용자의 잠재적 상태입니다.

속성

클립보드에 링크 복사됨
추상 val AccessToken: 문자열

사용자의 현재 액세스 토큰을 반환합니다. 사용자가 로그아웃하면 빈 액세스 토큰이 반환됩니다.

클립보드에 링크 복사됨
추상 val apiKeyAuth: ApiKeyAuth

사용자가 API 키를 managed 수 있도록 ApiKeyAuth 인터페이스에 대한 액세스 권한을 부여합니다.

클립보드에 링크 복사됨
추상 val 앱: 앱

이 사용자가 연결된 앱 입니다.

클립보드에 링크 복사됨
추상 val DeviceId: 문자열

사용자가 로그인한 기기의 고유 식별자를 반환합니다.

클립보드에 링크 복사됨
추상 val 기능: 함수

App Services 함수를 호출하기 위한 래퍼를 반환합니다.

클립보드에 링크 복사됨
추상 val id: 문자열

사용자의 서버 ID입니다.

클립보드에 링크 복사됨
추상 val ID: 목록<UserIdentity>

이 사용자에 대해 활성화된 인증 제공자가 정의한 사용자의 ID 목록을 반환합니다.

클립보드에 링크 복사됨
추상 val 신원: 문자열

사용자의 서버 ID입니다.

클립보드에 링크 복사됨
추상 val 로그인: 부울

이 사용자가 여전히 App Services 애플리케이션에 로그인되어 있는지 여부를 반환합니다.

클립보드에 링크 복사됨
추상 val provider: AuthenticationProvider

사용자 로그인에 사용되는 제공자 유형을 반환합니다. 사용자가 로그아웃해도 사용자를 로그인할 때 마지막으로 사용된 인증 제공자가 반환됩니다.

클립보드에 링크 복사됨
추상 val refreshToken: 문자열

사용자의 현재 새로 고침 토큰을 반환합니다. 사용자가 로그아웃하면 빈 새로 고침 토큰이 반환됩니다.

클립보드에 링크 복사됨
추상 val 상태: User.State

이 사용자가 속한 상태 입니다.

함수

클립보드에 링크 복사됨
@실험적RealmSerializerApi
인라인 fun <t> 사용자.customData(): t?
@실험적RealmSerializerApi
fun <t> 사용자.customData(serializer: KSerializer<T>): t?

Realm 앱에서 사용자와 연결된 사용자 지정 사용자 데이터를 T 로 반환합니다.

클립보드에 링크 복사됨
인라인 fun 사용자.customDataAsBsonDocument(): BsonDocument?

Realm 앱에서 사용자와 연결된 사용자 지정 사용자 데이터를 BsonDocument 로 반환합니다.

클립보드에 링크 복사됨
추상 일시 중단 fun 삭제()

Atlas App Services App에서 이 사용자를 영구적으로 삭제합니다.

클립보드에 링크 복사됨
추상 연산자 재정의 fun 같음(other: Any?): 부울

두 명의 사용자가 동일한 사용자 ID를 가지고 있고 동일한 앱에 연결된 경우 동등한 것으로 간주됩니다.

클립보드에 링크 복사됨
추상 일시 중단 fun 링크 자격 증명(credentials: 자격 증명): 사용자

현재 사용자를 지정된 자격 증명으로 나타나는 새 사용자 ID와 연결합니다.

클립보드에 링크 복사됨
추상 일시 중단 fun 로그아웃()

Realm 앱에서 사용자를 로그아웃합니다. 이렇게 하면 기기에서 사용자의 등록이 해제되고 사용자의 Realm과의 동기화가 중지됩니다. User.remove 가 호출되기 전에는 사용자가 소유한 모든 Realm이 장치에서 삭제되지 않습니다.

클립보드에 링크 복사됨
@실험적RealmSerializerApi
인라인 fun <t> 사용자.프로필(): t
@실험적RealmSerializerApi
fun <t> 사용자.프로필(serializer: KSerializer<T>): t

이 사용자의 프로필을 T 로 반환합니다.

클립보드에 링크 복사됨
인라인 fun 사용자.ProfileAsBsonDocument(): BsonDocument

이 사용자의 프로필을 BsonDocument 로 반환합니다.

클립보드에 링크 복사됨
추상 일시 중단 fun refreshCustomData()

Realm 앱에서 사용자 지정 사용자 데이터를 다시 가져옵니다.

클립보드에 링크 복사됨
추상 일시 중단 fun 제거(): 사용자

사용자 및 사용자가 가진 모든 Realm을 장치에서 제거합니다. 서버에서 데이터가 제거되지 않습니다.