클래스 사용자

Atlas Device SDK는 더 이상 사용되지 않습니다. 자세한 내용은 지원 중단 페이지 를 참조하세요.

io.realm.mongodb

java.lang.Object

io.realm.mongodb.User

사용자 는 Realm 앱 기능에 액세스하기 위해 사용자의 메타데이터와 토큰을 보유합니다. 사용자는 동기화된 Realm을 구성하는 데 사용되며 Functions 를 통해 Realm 앱 Functions 를 호출하고 원격 Realm 앱에 액세스할 수 액세스 을 부여합니다.

mongo MongoClient 를 통한 mongo

팁

다음도 참조하세요.

App.login(Credentials)
io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(User, string)

중첩된 클래스 요약

수정자 및 유형	클래스 및 설명
`public static final`	User.State

메서드 요약

수정자 및 유형	메서드 및 설명
공개 부울	equals ( Object o ) 두 명의 사용자가 동일한 사용자 ID를 가지고 있고 동일한 앱에 연결된 경우 동등한 것으로 간주됩니다.
공개 string	getAccessToken () 사용자의 현재 액세스 토큰을 반환합니다.
공개 동기화 ApiKeyAuth	getApiKeys () 현재 사용자가 제어하는 API 키를 관리하기 위한 래퍼를 반환합니다.
공개 앱	getApp () 이 사용자가 연결된 앱 을 반환합니다.
공개 문서	getCustomData () Realm 앱에서 사용자와 연결된 사용자 지정 사용자 데이터를 반환합니다.
공개 string	getDeviceId () 사용자가 로그인한 기기의 고유 식별자를 반환합니다.
공개 함수	getFunctions ( CodecRegistry codecRegistry ) 인수와 결과를 인코딩하고 디코딩하기 위해 사용자 지정 코덱 레지스트리를 사용하여 Realm Functions를 호출하기 위한 함수 관리자를 반환합니다.
public synchronized Functions	getFunctions () MongoDB Realm Functions를 호출하기 위한 함수 관리자를 반환합니다.
공개 string	getId () 사용자의 서버 ID를 반환합니다.
공개 목록	getIdentities () 사용자 ID의 새 목록을 반환합니다.
공개 동기화 MongoClient	getMongoClient ( String serviceName ) 데이터베이스 의 문서에 액세스하기 위한 MongoClient 인스턴스 를 반환합니다.
공개 사용자 프로필	getProfile () 이 사용자의 프로필을 반환합니다.
public Credentials.Provider	getProviderType () 사용자를 기록하는 데 사용되는 제공자 유형을 반환합니다.
public synchronized Push	getPush ( String serviceName ) 푸시 알림 등록을 관리하기 위한 푸시 인스턴스를 반환합니다.
공개 string	getRefreshToken () 사용자의 현재 새로 고침 토큰을 반환합니다.
공개 User.State	getState () 사용자가 있는 상태 를 반환합니다.
public int	hashCode ()
공개 부울	isLoggedIn () 사용자가 현재 로그인되어 있으면 true를 반환합니다.
공개 사용자	linkCredentials ( Credentials credentials ) 현재 사용자를 지정된 자격 증명으로 나타나는 새 사용자 ID와 연결합니다.
public RealmAsyncTask	linkCredentialsAsync ( Credentials credentials, io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) 현재 사용자를 지정된 자격 증명으로 나타나는 새 사용자 ID와 연결합니다.
public void	logOut () Realm 앱에서 사용자를 로그아웃합니다.
public RealmAsyncTask	logOutAsync ( io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Realm 앱에서 사용자를 비동기적으로 로그아웃합니다.
public RealmAsyncTask	refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback ) Realm 앱에서 사용자 지정 사용자 데이터를 비동기적으로 다시 가져옵니다.
공개 문서	refreshCustomData () Realm 앱에서 사용자 지정 사용자 데이터를 다시 가져옵니다.
공개 사용자	remove () 이 메서드를 호출하면 사용자 및 사용자가 가진 모든 Realm이 장치에서 제거됩니다.
public RealmAsyncTask	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

메서드 세부 정보

같음

public boolean equals ( Object o )
두 명의 사용자가 동일한 사용자 ID를 가지고 있고 동일한 앱에 연결된 경우 동등한 것으로 간주됩니다. 재정의 `equals` 클래스 객체 에서

getAccessToken

public String getAccessToken ()
사용자의 현재 액세스 토큰을 반환합니다. 반환 현재 액세스 토큰.

getApiKeys

public synchronized ApiKeyAuth getApiKeys ()
현재 사용자가 제어하는 API 키를 관리하기 위한 래퍼를 반환합니다. 반환 현재 사용자가 제어하는 API 키를 관리하기 위한 래퍼입니다. 스로우 불법적인 상태 예외 - 현재 로그인한 사용자가 없는 경우.

getApp

public App getApp ()
이 사용자가 연결된 앱 을 반환합니다. 반환 이 사용자가 연결된 앱 입니다.

getCustomData

public Document getCustomData ()
Realm 앱에서 사용자와 연결된 사용자 지정 사용자 데이터 반환합니다. 데이터는 사용자의 액세스 토큰이 새로 고쳐지거나 refreshCustomData()를 명시적으로 호출할 때만 새로 고쳐집니다. 반환 사용자와 연결된 사용자 지정 사용자 데이터입니다.

getDeviceId

public String getDeviceId ()
사용자가 로그인한 기기의 고유 식별자를 반환합니다. 반환 사용자의 고유한 기기 식별자입니다.

getFunctions

public Functions getFunctions ( CodecRegistry codecRegistry )
인수와 결과를 인코딩하고 디코딩하기 위해 사용자 지정 코덱 레지스트리를 사용하여 Realm Functions를 호출하기 위한 함수 관리자를 반환합니다. 매개변수 `codecRegistry` - 원격 Realm 앱에 대한 인수와 결과를 인코딩 및 디코딩하는 데 사용할 코덱 레지스트리입니다. 팁 다음도 참조하세요. 함수

public synchronized Functions getFunctions ()
MongoDB Realm Functions를 호출하기 위한 함수 관리자를 반환합니다. 그러면 연결된 앱의 기본 코덱 레지스트리를 사용하여 인수와 결과를 인코딩하고 디코딩합니다. 팁 다음도 참조하세요. 함수

getId

public String getId ()
사용자의 서버 ID를 반환합니다. 반환 사용자의 서버 ID입니다.

getIdentities

public List getIdentities ()
사용자 ID의 새 목록을 반환합니다. 반환 ID 목록. 팁 다음도 참조하세요. UserIdentity

getMongoClient

public synchronized MongoClient getMongoClient ( String serviceName )
데이터베이스 의 문서에 액세스하기 위한 MongoClient 인스턴스 를 반환합니다. 매개변수 `serviceName` - 서버에 연결하는 데 사용되는 서비스 이름입니다.

getProfile

public UserProfile getProfile ()
이 사용자의 프로필을 반환합니다. 반환 이 사용자의 프로필

getProviderType

public Credentials.Provider getProviderType ()
사용자를 기록하는 데 사용되는 제공자 유형을 반환합니다. 반환 사용자의 제공자 유형

getPush

public synchronized Push getPush ( String serviceName )
푸시 알림 등록을 관리하기 위한 푸시 인스턴스를 반환합니다. 매개변수 `serviceName` - 서버에 연결하는 데 사용되는 서비스 이름입니다.

getRefreshToken

public String getRefreshToken ()
사용자의 현재 새로 고침 토큰을 반환합니다. 반환 현재 새로 고침 토큰.

getState

public User.State getState ()
사용자가 있는 상태 를 반환합니다. 반환 사용자의 상태 입니다.

해시 코드

public int hashCode ()
재정의 `hashCode` 클래스 객체 에서

isLoggedIn

public boolean isLoggedIn ()
사용자가 현재 로그인되어 있으면 true를 반환합니다. 이 사용자가 여전히 MongoDB Realm 앱에 로그인되어 있는지 여부를 반환합니다. 반환 `true` 여전히 로그인되어 있으면 `false` 을 입력합니다.

링크 자격 증명

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의 기존 사용자 두 명을 연결할 수 없습니다. 제공된 자격 증명은 다른 사용자가 사용한 적이 없어야 합니다.

매개변수

credentials - 현재 사용자와 연결할 자격 증명입니다.

반환

자격 증명 연결된 사용자입니다.

스로우

불법적인 상태 예외 - 현재 로그인한 사용자가 없는 경우.

LinkCredentialsAsync

public RealmAsyncTask linkCredentialsAsync (

Credentials credentials,

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

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

참고: MongoDB Realm의 기존 사용자 두 명을 연결할 수 없습니다. 제공된 자격 증명은 다른 사용자가 사용한 적이 없어야 합니다.

매개변수

credentials - 현재 사용자와 연결할 자격 증명입니다.
callback - 사용자 ID가 연결되었거나 실패했을 때 콜백합니다. 콜백은 항상 이 메서드가 호출되는 동일한 스레드에서 발생합니다.

스로우

불법적인 상태 예외 - 루퍼가 아닌 스레드에서 호출된 경우.

로그아웃

public void logOut ()

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

Realm 앱이 로그아웃을 확인하면 등록된 모든 AuthenticationListener 에 알림이 전송되고 이 장치에서 사용자 자격 증명이 삭제됩니다.

익명 사용자를 로그아웃하면 User.State.LOGGED_OUT 으로 표시하는 대신 즉시 제거됩니다.

다른 모든 사용자는 User.State.LOGGED_OUT으로 표시되며 여전히 App.allUsers()에 의해 반환됩니다. 사용자를 호출하여 완전히 제거할 수 있습니다. ()를 제거.

스로우

AppException - 사용자가 Realm 앱에서 로그아웃하는 동안 오류가 발생한 경우

logOutAsync

public RealmAsyncTask logOutAsync (

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

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

Realm 앱이 로그아웃을 확인하면 등록된 모든 AuthenticationListener 에 알림이 전송되고 이 장치에서 사용자 자격 증명이 삭제됩니다.

익명 사용자를 로그아웃하면 User.State.LOGGED_OUT 으로 표시하는 대신 즉시 제거됩니다.

다른 모든 사용자는 User.State.LOGGED_OUT으로 표시되며 여전히 App.allUsers()에 의해 반환됩니다. 사용자를 호출하여 완전히 제거할 수 있습니다. ()를 제거.

매개변수

callback - 로그아웃 완료 또는 실패 시 콜백합니다. 콜백은 항상 이 메서드가 호출되는 동일한 스레드에서 발생합니다.

스로우

불법적인 상태 예외 - 루퍼가 아닌 스레드에서 호출된 경우.

refreshCustomData

public RealmAsyncTask refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback )
Realm 앱에서 사용자 지정 사용자 데이터 비동기적으로 다시 가져옵니다. 이는 refreshCustomData() 의 비동기 변형입니다. 매개변수 `callback` - 요청의 결과 또는 오류를 수신할 콜백입니다. 반환 진행 중인 작업을 나타내는 작업입니다. 스로우 불법적인 상태 예외 - 루퍼 스레드에서 호출되지 않은 경우.

public Document refreshCustomData ()
Realm 앱에서 사용자 지정 사용자 데이터를 다시 가져옵니다. 반환 사용자와 연결된 업데이트된 사용자 지정 사용자 데이터입니다. 스로우 AppException - 어떤 식으로든 요청 이 실패한 경우.

제거

public User remove ()

이 메서드를 호출하면 사용자 및 사용자가 가진 모든 Realm이 장치에서 제거됩니다. 서버에서 데이터가 제거되지 않습니다. 이 메서드를 호출할 때 사용자가 로그인되어 있었다면 데이터가 삭제되기 전에 사용자가 로그아웃됩니다.

반환

제거된 사용자입니다.

스로우

AppException - 사용자를 제거 하는 동안 오류가 발생한 경우.

removeAsync

public RealmAsyncTask removeAsync (

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

이 메서드를 호출하면 사용자와 사용자가 가진 모든 Realm이 장치에서 비동기적으로 제거됩니다. 서버에서 데이터가 제거되지 않습니다. 이 메서드를 호출할 때 사용자가 로그인되어 있었다면 데이터가 삭제되기 전에 사용자가 로그아웃됩니다.

매개변수

callback - 사용자 제거가 완료되었거나 실패했을 때 콜백합니다. 콜백은 항상 이 메서드가 호출되는 동일한 스레드에서 발생합니다.

스로우

불법적인 상태 예외 - 루퍼가 아닌 스레드에서 호출된 경우.

돌아가기

RealmResultTask

User.State