Docs Home → Develop Applications → Atlas Device SDKs

Class ApiKeyAuth

Realm is now Atlas Device SDK – Learn More

io.realm.mongodb.auth

java.lang.Object

io.realm.mongodb.auth.ApiKeyAuth

This class exposes functionality for a user to manage API keys under their control.

Method Summary

Modifier and Type	Method and Description
protected abstract void	call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )
public ApiKey	create ( String name ) Creates a user API key that can be used to authenticate as the user.
public RealmAsyncTask	createAsync ( String name, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Asynchronously creates a user API key that can be used to authenticate as the user.
public void	delete ( ObjectId id ) Deletes a specific API key created by the user.
public RealmAsyncTask	deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Deletes a specific API key created by the user.
public void	disable ( ObjectId id ) Disables a specific API key created by the user.
public RealmAsyncTask	disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Disables a specific API key created by the user.
public void	enable ( ObjectId id ) Enables a specific API key created by the user.
public RealmAsyncTask	enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Enables a specific API key created by the user.
public boolean	equals ( Object o )
public ApiKey	fetch ( ObjectId id ) Fetches a specific user API key associated with the user.
public RealmAsyncTask	fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback ) Fetches all API keys associated with the user.
public List	fetchAll () Fetches all API keys associated with the user.
public RealmAsyncTask	fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Fetches a specific user API key associated with the user.
public App	getApp () Returns the App that this instance in associated with.
public User	getUser () Returns the User that this instance in associated with.
public int	hashCode ()
public String	toString ()

Inherited Methods

Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Method Detail

call

protected abstract void call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )

create

public ApiKey create ( String name )
Creates a user API key that can be used to authenticate as the user.The value of the key must be persisted at this time as this is the only time it is visible. The key is enabled when created. It can be disabled by calling disable(ObjectId) . Parameters `name` - the name of the key Returns the new API key for the user. Throws AppException - if the server failed to create the API key.

createAsync

public RealmAsyncTask createAsync ( String name, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback )
Asynchronously creates a user API key that can be used to authenticate as the user.The value of the key must be persisted at this time as this is the only time it is visible. The key is enabled when created. It can be disabled by calling disable(ObjectId) . Parameters `name` - the name of the key `callback` - callback when key creation has completed or failed. The callback will always happen on the same thread as this method is called on. Throws IllegalStateException - if called from a non-looper thread.

public RealmAsyncTask createAsync (

String name,

io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback

)

Asynchronously creates a user API key that can be used to authenticate as the user.The value of the key must be persisted at this time as this is the only time it is visible.

The key is enabled when created. It can be disabled by calling disable(ObjectId) .

Parameters

name - the name of the key
callback - callback when key creation has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

IllegalStateException - if called from a non-looper thread.

delete

public void delete ( ObjectId id )
Deletes a specific API key created by the user. Parameters `id` - the id of the key to delete. Throws AppException - if the server failed to delete the API key.

deleteAsync

public RealmAsyncTask deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Deletes a specific API key created by the user. Parameters `id` - the id of the key to delete. `callback` - callback used when the was deleted or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

disable

public void disable ( ObjectId id )
Disables a specific API key created by the user. Parameters `id` - the id of the key to disable. Throws AppException - if the server failed to disable the API key.

disableAsync

public RealmAsyncTask disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Disables a specific API key created by the user. Parameters `id` - the id of the key to disable. `callback` - callback used when the key was disabled or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

enable

public void enable ( ObjectId id )
Enables a specific API key created by the user. Parameters `id` - the id of the key to enable. Throws AppException - if the server failed to enable the API key.

enableAsync

public RealmAsyncTask enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Enables a specific API key created by the user. Parameters `id` - the id of the key to enable. `callback` - callback used when the key was enabled or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

equals

public boolean equals ( Object o )
Overrides `equals` in class Object

fetch

public ApiKey fetch ( ObjectId id )
Fetches a specific user API key associated with the user. Parameters `id` - the id of the key to fetch. Throws AppException - if the server failed to fetch the API key.

fetchAll

public RealmAsyncTask fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback )
Fetches all API keys associated with the user. Parameters `callback` - callback used when the keys were fetched or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

public List fetchAll ()
Fetches all API keys associated with the user. Throws AppException - if the server failed to fetch the API keys.

fetchAsync

public RealmAsyncTask fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback )
Fetches a specific user API key associated with the user. Parameters `id` - the id of the key to fetch. `callback` - callback used when the key was fetched or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

getApp

public App getApp ()
Returns the App that this instance in associated with. Returns The App that this instance in associated with.

getUser

public User getUser ()
Returns the User that this instance in associated with. Returns The User that this instance in associated with.

hashCode

public int hashCode ()
Overrides `hashCode` in class Object

toString

public String toString ()
Overrides `toString` in class Object

← Class ApiKey

Class EmailPasswordAuth →

Class ApiKeyAuth.css-134mg1q{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.css-6vrlzm{border-radius:0!important;display:initial!important;margin:initial!important;}.css-1l4s55v{margin-top:-175px;position:absolute;padding-bottom:2px;}