Uses of Class
io.objectbox.sync.SyncCredentials

Packages that use SyncCredentials

Package	Description
io.objectbox.sync	ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g.
io.objectbox.sync.server

Uses of SyncCredentials in io.objectbox.sync

Subclasses of SyncCredentials in io.objectbox.sync

Modifier and Type	Class	Description
class	SyncCredentialsToken	Internal credentials implementation.
class	SyncCredentialsUserPassword	Internal credentials implementation for user and password authentication.

Fields in io.objectbox.sync with type parameters of type SyncCredentials

Modifier and Type	Field	Description
(package private) java.util.List<SyncCredentials>	SyncBuilder.credentials

Methods in io.objectbox.sync that return SyncCredentials

Modifier and Type	Method	Description
(package private) abstract SyncCredentials	SyncCredentials.createClone()	Creates a copy of these credentials.
(package private) SyncCredentials	SyncCredentialsUserPassword.createClone()
static SyncCredentials	SyncCredentials.google(java.lang.String idToken)	Authenticate with a Google account ID token obtained via Google Sign-In.
static SyncCredentials	SyncCredentials.jwtAccessToken(java.lang.String jwtAccessToken)	JSON Web Token (JWT): an access token that is used to access resources.
static SyncCredentials	SyncCredentials.jwtCustomToken(java.lang.String jwtCustomToken)	JSON Web Token (JWT): a token that is neither an ID, access, nor refresh token.
static SyncCredentials	SyncCredentials.jwtIdToken(java.lang.String jwtIdToken)	JSON Web Token (JWT): an ID token that typically provides identity information about the authenticated user.
static SyncCredentials	SyncCredentials.jwtRefreshToken(java.lang.String jwtRefreshToken)	JSON Web Token (JWT): a refresh token that is used to obtain a new access token.
static SyncCredentials	SyncCredentials.none()	No authentication, unsecured.
static SyncCredentials	SyncCredentials.obxAdminUser(java.lang.String user, java.lang.String password)	ObjectBox admin users (username/password)
static SyncCredentials	SyncCredentials.sharedSecret(byte[] secret)	Authenticate with a shared secret.
static SyncCredentials	SyncCredentials.sharedSecret(java.lang.String secret)	Authenticate with a shared secret.
static SyncCredentials	SyncCredentials.userAndPassword(java.lang.String user, java.lang.String password)	Generic credential type suitable for ObjectBox admin (and possibly others in the future)

Methods in io.objectbox.sync with parameters of type SyncCredentials

Modifier and Type	Method	Description
static SyncBuilder	Sync.client(BoxStore boxStore, java.lang.String url, SyncCredentials credentials)	Starts building a SyncClient.
static SyncBuilder	Sync.client(BoxStore boxStore, java.lang.String url, SyncCredentials[] multipleCredentials)	Starts building a SyncClient.
static SyncHybridBuilder	Sync.hybrid(BoxStoreBuilder storeBuilder, java.lang.String url, SyncCredentials authenticatorCredentials)	Starts building a SyncHybrid, a client/server hybrid typically used for embedded cluster setups.
static SyncServerBuilder	Sync.server(BoxStore boxStore, java.lang.String url, SyncCredentials authenticatorCredentials)	Starts building a SyncServer.
static SyncServerBuilder	Sync.server(BoxStore boxStore, java.lang.String url, SyncCredentials[] multipleAuthenticatorCredentials)	Starts building a SyncServer.
void	SyncClient.setLoginCredentials(SyncCredentials credentials)	Updates the login credentials.
void	SyncClient.setLoginCredentials(SyncCredentials[] multipleCredentials)	Updates the login credentials.
void	SyncClientImpl.setLoginCredentials(SyncCredentials credentials)
void	SyncClientImpl.setLoginCredentials(SyncCredentials[] multipleCredentials)

Constructors in io.objectbox.sync with parameters of type SyncCredentials

Constructor	Description
SyncBuilder(BoxStore boxStore, SyncCredentials credentials)
SyncBuilder(BoxStore boxStore, SyncCredentials[] multipleCredentials)
SyncBuilder(BoxStore boxStore, java.lang.String url, SyncCredentials credentials)
SyncBuilder(BoxStore boxStore, java.lang.String url, SyncCredentials[] multipleCredentials)
SyncHybridBuilder(BoxStoreBuilder storeBuilder, java.lang.String url, SyncCredentials authenticatorCredentials)	Internal API; use Sync.hybrid(BoxStoreBuilder, String, SyncCredentials) instead.

Uses of SyncCredentials in io.objectbox.sync.server

Methods in io.objectbox.sync.server with parameters of type SyncCredentials

Modifier and Type	Method	Description
SyncServerBuilder	SyncServerBuilder.authenticatorCredentials(SyncCredentials authenticatorCredentials)	Adds additional authenticator credentials to authenticate clients or peers with.
SyncServerBuilder	SyncServerBuilder.authenticatorCredentials(SyncCredentials[] multipleAuthenticatorCredentials)	Adds additional authenticator credentials to authenticate clients or peers with.
SyncServerBuilder	SyncServerBuilder.clusterPeer(java.lang.String url, SyncCredentials credentials)	Adds a (remote) cluster peer, to which this server should connect to as a client using the given credentials.
SyncServerBuilder	SyncServerBuilder.peer(java.lang.String url, SyncCredentials credentials)	Deprecated. Use SyncServerBuilder.clusterPeer(String, SyncCredentials) instead.

Constructors in io.objectbox.sync.server with parameters of type SyncCredentials

Constructor	Description
SyncServerBuilder(BoxStore boxStore, java.lang.String url, SyncCredentials authenticatorCredentials)	Use Sync.server(BoxStore, String, SyncCredentials) instead.
SyncServerBuilder(BoxStore boxStore, java.lang.String url, SyncCredentials[] multipleAuthenticatorCredentials)	Use Sync.server(BoxStore, String, SyncCredentials) instead.