com.brein.api

Class Breinify

java.lang.Object

com.brein.api.Breinify

public class Breinify
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Breinify()

Method Summary

Modifier and Type	Method and Description
static void	activity() Sends an activity to the engine utilizing the API.
static void	activity(BreinUser user, java.lang.String activityType, java.lang.String categoryType, java.lang.String description) Sends an activity to the engine utilizing the API.
static void	activity(BreinUser user, java.lang.String activityType, java.lang.String categoryType, java.lang.String description, java.util.function.Function<java.lang.String,java.lang.Void> errorCallback) Sends an activity to the engine utilizing the API.
static BreinActivity	getBreinActivity()
static BreinLookup	getBreinLookup()
static BreinRecommendation	getBreinRecommendation()
static BreinTemporalData	getBreinTemporalData()
static BreinConfig	getConfig() gets the config
static BreinResult	lookup(BreinLookup breinLookup, BreinUser user, BreinDimension dimension) Retrieves a lookup result from the engine.
static BreinResult	lookup(BreinUser user, BreinDimension dimension) Retrieves a lookup result from the engine.
static BreinResult	recommendation(BreinRecommendation breinRecommendationPara) Sends a recommendation request to the engine utilizing the API.
static void	setConfig(BreinConfig breinConfig) sets the configuration
static void	shutdown() Shutdown Breinify services
static BreinResult	temporalData(BreinTemporalData breinTemporalData, BreinUser user) Sends a temporalData to the engine utilizing the API.
static BreinResult	temporalData(BreinUser user) Sends a temporalData to the engine utilizing the API.

Methods inherited from class java.lang.Object

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

Constructor Detail

Breinify

public Breinify()

Method Detail

setConfig

public static void setConfig(BreinConfig breinConfig)

sets the configuration

Parameters:

breinConfig - config object

getConfig

public static BreinConfig getConfig()

gets the config

Returns:

config

getBreinActivity

public static BreinActivity getBreinActivity()

Returns:

breinActivity instance

getBreinLookup

public static BreinLookup getBreinLookup()

Returns:

breinLookup instance

getBreinTemporalData

public static BreinTemporalData getBreinTemporalData()

Returns:

temporaldata instance

getBreinRecommendation

public static BreinRecommendation getBreinRecommendation()

Returns:

breinRecommendation instance

activity

public static void activity(BreinUser user,
                            java.lang.String activityType,
                            java.lang.String categoryType,
                            java.lang.String description,
                            java.util.function.Function<java.lang.String,java.lang.Void> errorCallback)

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

Parameters:

user - a plain object specifying the user information the activity belongs to

activityType - the type of the activity collected, i.e., one of search, login, logout, addToCart, removeFromCart, checkOut, selectProduct, or other. if not specified, the default other will be used

categoryType - the category of the platform/service/products, i.e., one of apparel, home, education, family, food, health, job, services, or other

description - a string with further information about the activity performed

errorCallback - a callback function that is invoked in case of an error (can be null)

activity

public static void activity(BreinUser user,
                            java.lang.String activityType,
                            java.lang.String categoryType,
                            java.lang.String description)

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

Parameters:

user - a plain object specifying the user information the activity belongs to

activityType - the type of the activity collected, i.e., one of search, login, logout, addToCart, removeFromCart, checkOut, selectProduct, or other. if not specified, the default other will be used

categoryType - the category of the platform/service/products, i.e., one of apparel, home, education, family, food, health, job, services, or other

description - a string with further information about the activity performed

activity

public static void activity()

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function. Furthermore it uses the internal instance of BreinActivity. In order to use this method correctly you have to do the following:

// retrieve BreinActivity instance from Breinify class BreinActivity breinActivity = Breinify.getBreinActivity();

// set methods as desired to breinActivity (for instance) breinActivity.setBreinUser(new BreinUser("user.name@email.com"); ...

// invoke this method Breinify.activity();

This request is asynchronous.

lookup

public static BreinResult lookup(BreinUser user,
                                 BreinDimension dimension)

Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.

This request is synchronous.

Parameters:

user - a plain object specifying information about the user to retrieve data for.

dimension - an object (with an array) containing the names of the dimensions to lookup.

Returns:

response from request wrapped in an object called BreinResponse

lookup

public static BreinResult lookup(BreinLookup breinLookup,
                                 BreinUser user,
                                 BreinDimension dimension)

Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.

This request is synchronous.

Parameters:

breinLookup - a plain object specifying the lookup information.

user - a plain object specifying information about the user to retrieve data for.

dimension - an object (with an array) containing the names of the dimensions to lookup.

Returns:

response from request wrapped in an object called BreinResponse

temporalData

public static BreinResult temporalData(BreinUser user)

Sends a temporalData to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

Furthermore it uses the internal instance of BreinTemporalData.

Parameters:

user - a plain object specifying information about the user to retrieve data for.

Returns:

result from the Breinify engine

temporalData

public static BreinResult temporalData(BreinTemporalData breinTemporalData,
                                       BreinUser user)

Sends a temporalData to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

Parameters:

breinTemporalData - a plain object specifying the information of the temporaldata.

user - a plain object specifying information about the user to retrieve data for.

Returns:

result from the Breinify engine

recommendation

public static BreinResult recommendation(BreinRecommendation breinRecommendationPara)

Sends a recommendation request to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

Parameters:

breinRecommendationPara - contains the brein recommendation object

Returns:

BreinResult object

shutdown

public static void shutdown()

Shutdown Breinify services