oracle.cloud.mobile.core

Class Bots

java.lang.Object

oracle.cloud.mobile.core.Bots

public final class Bots
extends java.lang.Object

Bots Entry Point

Method Summary

Modifier and Type	Method and Description
static void	destroy() Terminate the Bots facilities.
static BotsConnectionStatus	getBotsConnectionStatus() Accessor method for the current BotsConnectionStatus, or null if init(Application, Settings, BotsCallback) hasn't been called yet.
static Config	getConfig() Accessor method for the currently connected app configuration.
static Conversation	getConversation() Accessor method for the current conversation.
static java.lang.String	getFirebaseCloudMessagingProjectId() Accessor method to get the Firebase Cloud Messaging project id that was linked to the application via the Web portal.
static InitializationStatus	getInitializationStatus() Accessor method for the current Initialization status.
static LoginResult	getLastLoginResult() Accessor for last known LoginResult or null if the user is anonymous or init(Application, Settings, BotsCallback) hasn't been called
static Settings	getSettings() Accessor method for the SDK settings.
static void	init(android.app.Application application) Initializes Bots without settings.
static void	init(android.app.Application application, Settings settings, BotsCallback callback) Initialize the Bots SDK with the provided settings.
static void	login(java.lang.String userId, java.lang.String jwt, BotsCallback callback) Logs in a new Bots user.
static void	logout(BotsCallback callback) Logs out the current user.
static void	setFirebaseCloudMessagingToken(java.lang.String token) Method used to register the Firebase Cloud Messaging token to Bots
static void	startConversation(BotsCallback callback) Force-start a conversation for the current user

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(android.app.Application application)

Initializes Bots without settings. Use this only if you intend to call init(Application, Settings, BotsCallback) outside of an Application class

This may only be called from Application.onCreate().

Parameters:

application - The Application

init

public static void init(android.app.Application application,
                        Settings settings,
                        BotsCallback callback)

Initialize the Bots SDK with the provided settings.

This may only be called from Application.onCreate(), unless init(Application) was called there.

Use Bots.getSettings() to retrieve and modify the given settings object.

Parameters:

application - The Application

settings - The Settings to use

callback - An optional BotsCallback instance to be notified of the result. Call BotsCallback.Response.getData() to check the InitializationStatus

See Also:

Settings, BotsCallback, BotsCallback.Response, InitializationStatus

login

public static void login(java.lang.String userId,
                         java.lang.String jwt,
                         BotsCallback callback)

Logs in a new Bots user.

You can either use this method to transition from logged out state to logged in, or to switch the currently logged in user to a different one. You may not call login while the conversation screen is shown. Doing so will result in a no-op. init(Application, Settings, BotsCallback) must have been called prior to calling login.

Parameters:

userId - The distinct id of the user to login. Must not be null.

jwt - jwt used to prove the origin of the login request. Must not be null.

callback - An optional BotsCallback instance to be notified of the result. Call BotsCallback.Response.getData() to check the LoginResult

See Also:

BotsCallback, BotsCallback.Response, LoginResult

logout

public static void logout(BotsCallback callback)

Logs out the current user.

Calling this method while in anonymous state has no effect. You may not call logout while the conversation screen is shown. Doing so will result in a no-op.

Parameters:

callback - An optional BotsCallback instance to be notified of the result. Call BotsCallback.Response.getData() to check the LogoutResult

See Also:

BotsCallback, BotsCallback.Response, LogoutResult

startConversation

public static void startConversation(BotsCallback callback)

Force-start a conversation for the current user

Creates a user and conversation on the server, allowing the business to reach out proactively to the user via the public API.

It is strongly recommended to only call this method in the case where a message is likely to be sent.

This method is called automatically when starting a conversation via the Conversation.sendMessage(Message) or Conversation.uploadImage(Message, BotsCallback) methods, or when a user sends a message via the conversation activity.

If a conversation already exists for the current user, this call is a no-op.

Parameters:

callback - An optional BotsCallback instance to be notified of the result.

See Also:

BotsCallback, BotsCallback.Response

destroy

public static void destroy()

Terminate the Bots facilities.

Bots is automatically terminated when the application exits. This method does not, usually, have to be called manually.

getSettings

public static Settings getSettings()

Accessor method for the SDK settings.

Use this object to update settings at run time. Note: Some settings may only be configured at init time. See the Settings class reference for more information.

Returns:

Settings object passed in init(Application, Settings, BotsCallback), or null if Bots hasn't been initialized yet.

See Also:

Settings

getConversation

public static Conversation getConversation()

Accessor method for the current conversation.

Returns:

Current conversation, or null if Bots.init() hasn't been called yet.

See Also:

Conversation

getConfig

public static Config getConfig()

Accessor method for the currently connected app configuration.

Returns:

Current app configuration, or null if Bots.init() hasn't been called yet.

See Also:

Config

getInitializationStatus

public static InitializationStatus getInitializationStatus()

Accessor method for the current Initialization status.

Returns:

Initialization status, or null if init(Application, Settings, BotsCallback) hasn't been called yet.

See Also:

InitializationStatus

getBotsConnectionStatus

public static BotsConnectionStatus getBotsConnectionStatus()

Accessor method for the current BotsConnectionStatus, or null if init(Application, Settings, BotsCallback) hasn't been called yet.

See Also:

BotsConnectionStatus

getLastLoginResult

public static LoginResult getLastLoginResult()

Accessor for last known LoginResult or null if the user is anonymous or init(Application, Settings, BotsCallback) hasn't been called

See Also:

LoginResult

getFirebaseCloudMessagingProjectId

public static java.lang.String getFirebaseCloudMessagingProjectId()

Accessor method to get the Firebase Cloud Messaging project id that was linked to the application via the Web portal.

Returns:

The Firebase Cloud Messaging project Id

setFirebaseCloudMessagingToken

public static void setFirebaseCloudMessagingToken(java.lang.String token)

Method used to register the Firebase Cloud Messaging token to Bots

Parameters:

token - The Firebase Cloud Messaging token