Package io.objectbox.sync

Class SyncCredentials

java.lang.Object

io.objectbox.sync.SyncCredentials

Direct Known Subclasses:

SyncCredentialsToken, SyncCredentialsUserPassword

public abstract class SyncCredentials
extends Object

Use the static helper methods to build Sync credentials, for example SyncCredentials.sharedSecret("secret").

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SyncCredentials.CredentialsType

Method Summary

Modifier and Type	Method	Description
SyncCredentials.CredentialsType	getType()
long	getTypeId()
static SyncCredentials	google(String idToken)	Authenticate with a Google account ID token obtained via Google Sign-In.
static SyncCredentials	none()	No authentication, unsecured.
static SyncCredentials	sharedSecret(byte[] secret)	Authenticate with a shared secret.
static SyncCredentials	sharedSecret(String secret)	Authenticate with a shared secret.
static SyncCredentials	userAndPassword(String user, String password)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

sharedSecret

public static SyncCredentials sharedSecret(String secret)

Authenticate with a shared secret. This could be a passphrase, big number or randomly chosen bytes. The string is expected to use UTF-8 characters.

sharedSecret

public static SyncCredentials sharedSecret(byte[] secret)

Authenticate with a shared secret. This could be a passphrase, big number or randomly chosen bytes.

google

public static SyncCredentials google(String idToken)

Authenticate with a Google account ID token obtained via Google Sign-In.

userAndPassword

public static SyncCredentials userAndPassword(String user,
 String password)

none

public static SyncCredentials none()

No authentication, unsecured. Use only for development and testing purposes.

getType

public SyncCredentials.CredentialsType getType()

getTypeId

public long getTypeId()