io.realm

Interface UserStore

All Known Implementing Classes:

SecureUserStore, SharedPrefsUserStore

public interface UserStore

See Also:

SyncManager.setUserStore(UserStore), SharedPrefsUserStore

This software is considered in beta phase. It indicates that any public interface can change without prior announcements. Moreover, classes, constructors, and methods annotated as beta are not considered at production quality, and should be used with care.

Interface for classes responsible for saving and retrieving Object Server users again.

Any implementation of a User Store is expected to not perform lengthy blocking operations as it might be called on the Main Thread. All implementations of this interface should be thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_USER_KEY

Method Summary

Modifier and Type	Method and Description
Collection<User>	allUsers() Returns a collection of all users saved in the User store.
User	get(String key) Retrieves the User with the given key.
User	put(String key, User user) Saves a User object under the given key.
User	remove(String key) Removes the user with the given key from the store.

Field Detail

CURRENT_USER_KEY

static final String CURRENT_USER_KEY

See Also:

Constant Field Values

Method Detail

put

User put(String key,
         User user)

Saves a User object under the given key. If another user already exists, it will be replaced.

Parameters:

key - key used to store the User.

user - User object to store.

Returns:

The previous user saved with this key or null if no user was replaced.

get

User get(String key)

Retrieves the User with the given key.

Parameters:

key - User saved under the given key or null if no user exists for that key.

remove

User remove(String key)

Removes the user with the given key from the store.

Parameters:

key - key for the user to remove.

Returns:

User that was removed or null if no user matched the key.

allUsers

Collection<User> allUsers()

Returns a collection of all users saved in the User store.

Returns:

Collection of all users. If no users exist, an empty collection is returned.