com.brein.api

Class Breinify

java.lang.Object

com.brein.api.Breinify

public class Breinify
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	activity(BreinActivity activity) Method to send an activity asynchronous.
static void	activity(BreinActivity activity, java.util.function.Consumer<BreinResult> callback) Method to send an activity asynchronous.
static void	activity(BreinUser user, java.lang.String activityType) Method to send an activity asynchronous.
static void	activity(BreinUser user, java.lang.String activityType, java.lang.String category, java.lang.String description) Method to send an activity asynchronous.
static void	activity(BreinUser user, java.lang.String activityType, java.lang.String category, java.lang.String description, java.util.function.Consumer<BreinResult> callback) Method to send an activity asynchronous.
static void	activity(MapBuilder<java.lang.String> identifiers, java.lang.String activityType) Method to send an activity asynchronous.
static void	activity(MapBuilder<java.lang.String> identifiers, java.lang.String activityType, java.util.function.Consumer<BreinResult> callback) Method to send an activity asynchronous.
static void	activity(MapBuilder<java.lang.String> identifiers, java.lang.String activityType, java.lang.String description) Method to send an activity asynchronous.
static void	activity(MapBuilder<java.lang.String> identifiers, java.lang.String activityType, java.lang.String description, java.util.function.Consumer<BreinResult> callback) Method to send an activity asynchronous.
static void	activity(MapBuilder<java.lang.String> identifiers, java.lang.String activityType, java.lang.String category, java.lang.String description, java.util.function.Consumer<BreinResult> callback) Method to send an activity asynchronous.
protected static Brein	getBrein()
static BreinResult	lookUp(BreinLookup data)
static BreinRecommendationResult	recommendation(BreinRecommendation data)
static BreinRecommendationResults	recommendation(BreinRecommendations data)
static Brein	setConfig(BreinConfig config) Specifies the overall configuration used by the library.
static Brein	setConfig(java.lang.String apiKey) Specifies the overall configuration used by the library.
static Brein	setConfig(java.lang.String apiKey, java.lang.String secret) Specifies the overall configuration used by the library.
static void	shutdown()
static BreinTemporalDataResult	temporalData() Method to retrieve temporal information based on temporal data.
static BreinTemporalDataResult	temporalData(BreinTemporalData data) Method to retrieve temporal information based on temporal data.
static BreinTemporalDataResult	temporalData(double latitude, double longitude, java.lang.String... shapeTypes) Method to retrieve temporal information based on temporal data.
static BreinTemporalDataResult	temporalData(java.lang.String ipAddress) Method to retrieve temporal information based on temporal data.

Methods inherited from class java.lang.Object

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

Method Detail

setConfig

public static Brein setConfig(BreinConfig config)

Specifies the overall configuration used by the library. The configuration must be set prior to any call to the API.

Parameters:

config - the configuration to use

Returns:

the Brein instance, usable if multiple different configurations are used

See Also:

Brein, BreinConfig

setConfig

public static Brein setConfig(java.lang.String apiKey)

Specifies the overall configuration used by the library. The configuration must be set prior to any call to the API.

Parameters:

apiKey - the API key to be used

Returns:

the Brein instance, usable if multiple different configurations are used

See Also:

Brein

setConfig

public static Brein setConfig(java.lang.String apiKey,
                              java.lang.String secret)

Specifies the overall configuration used by the library. The configuration must be set prior to any call to the API.

Parameters:

apiKey - the API key to be used

secret - the secret to be used to sign the messages (Verification Signature must be enabled for the API key)

Returns:

the Brein instance, usable if multiple different configurations are used

See Also:

Brein

activity

public static void activity(MapBuilder<java.lang.String> identifiers,
                            java.lang.String activityType)

Method to send an activity asynchronous.

Parameters:

identifiers - the identifiers of the user as chainable map (i.e., MapBuilder), e.g., email, sessionId, userId

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

See Also:

MapBuilder

activity

public static void activity(MapBuilder<java.lang.String> identifiers,
                            java.lang.String activityType,
                            java.util.function.Consumer<BreinResult> callback)

Method to send an activity asynchronous.

Parameters:

identifiers - the identifiers of the user as chainable map (i.e., MapBuilder), e.g., email, sessionId, userId

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

callback - callback to get informed whenever the activity was sent, the callback retrieves the BreinResult

See Also:

BreinResult, MapBuilder

activity

public static void activity(MapBuilder<java.lang.String> identifiers,
                            java.lang.String activityType,
                            java.lang.String description)

Method to send an activity asynchronous.

Parameters:

identifiers - the identifiers of the user as chainable map (i.e., MapBuilder), e.g., email, sessionId, userId

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

description - a textual description of the activity

See Also:

MapBuilder

activity

public static void activity(MapBuilder<java.lang.String> identifiers,
                            java.lang.String activityType,
                            java.lang.String description,
                            java.util.function.Consumer<BreinResult> callback)

Method to send an activity asynchronous.

Parameters:

identifiers - the identifiers of the user as chainable map (i.e., MapBuilder), e.g., email, sessionId, userId

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

description - a textual description of the activity

callback - callback to get informed whenever the activity was sent, the callback retrieves the BreinResult, can be null

See Also:

BreinResult, MapBuilder

activity

public static void activity(MapBuilder<java.lang.String> identifiers,
                            java.lang.String activityType,
                            java.lang.String category,
                            java.lang.String description,
                            java.util.function.Consumer<BreinResult> callback)

Method to send an activity asynchronous.

Parameters:

identifiers - the identifiers of the user as chainable map (i.e., MapBuilder), e.g., email, sessionId, userId

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

category - a category of the activity, e.g., apparel, food, or other, if null the configured default category will be used

description - a textual description of the activity

callback - callback to get informed whenever the activity was sent, the callback retrieves the BreinResult

See Also:

BreinResult, BreinConfig.setDefaultCategory(String), MapBuilder

activity

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

Method to send an activity asynchronous.

Parameters:

user - the BreinUser instance specifying information about the user performing the activity

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

See Also:

BreinUser

activity

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

Method to send an activity asynchronous.

Parameters:

user - the BreinUser instance specifying information about the user performing the activity

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

category - a category of the activity, e.g., apparel, food, or other, if null the configured default category will be used

description - a textual description of the activity

See Also:

BreinUser, BreinConfig.setDefaultCategory(String)

activity

public static void activity(BreinUser user,
                            java.lang.String activityType,
                            java.lang.String category,
                            java.lang.String description,
                            java.util.function.Consumer<BreinResult> callback)

Method to send an activity asynchronous.

Parameters:

user - the BreinUser instance specifying information about the user performing the activity

activityType - the type of the activity, e.g., login, pageView, addToCart, readArticle

category - a category of the activity, e.g., apparel, food, or other, if null the configured default category will be used

description - a textual description of the activity

callback - callback to get informed whenever the activity was sent, the callback retrieves the BreinResult

See Also:

BreinUser, BreinConfig.setDefaultCategory(String), BreinResult

activity

public static void activity(BreinActivity activity)

Method to send an activity asynchronous.

Parameters:

activity - the BreinActivity to be sent

See Also:

BreinActivity

activity

public static void activity(BreinActivity activity,
                            java.util.function.Consumer<BreinResult> callback)

Method to send an activity asynchronous.

Parameters:

activity - the BreinActivity to be sent

callback - callback to get informed whenever the activity was sent, the callback retrieves the BreinResult

See Also:

BreinActivity, BreinResult

temporalData

public static BreinTemporalDataResult temporalData()

Method to retrieve temporal information based on temporal data. This method uses the available information from the system it is running on to be passed to the API, which resolves the temporal information. Normally (if not using a VPN) the ip-address is a good source to determine, e.g., the location.

Returns:

the retrieved BreinTemporalDataResult

See Also:

BreinTemporalDataResult

temporalData

public static BreinTemporalDataResult temporalData(java.lang.String ipAddress)

Method to retrieve temporal information based on temporal data. This method uses the ipAddress to determine further information, i.e., weather, location, events, time, timezone, and holidays.

Parameters:

ipAddress - the address to resolve the information for

Returns:

the retrieved BreinTemporalDataResult

See Also:

BreinTemporalDataResult

temporalData

public static BreinTemporalDataResult temporalData(double latitude,
                                                   double longitude,
                                                   java.lang.String... shapeTypes)

Method to retrieve temporal information based on temporal data. This method uses the latitude and longitude to determine further information, i.e., weather, location, events, time, timezone, and holidays.

Parameters:

latitude - the latitude of the geo-coordinates to resolve

longitude - the longitude of the geo-coordinates to resolve

shapeTypes - the shape-types to retrieve (if empty, no shape-types will be returned), e.g., CITY, NEIGHBORHOOD, ZIP-CODES

Returns:

the retrieved BreinTemporalDataResult

See Also:

BreinTemporalDataResult

temporalData

public static BreinTemporalDataResult temporalData(BreinTemporalData data)

Method to retrieve temporal information based on temporal data. This method can be used to form any type of request utilizing BreinTemporalData.

Parameters:

data - the data specifying the temporal data to retrieve the temporal information for

Returns:

the retrieved BreinTemporalDataResult

See Also:

BreinTemporalData, BreinTemporalDataResult

shutdown

public static void shutdown()

getBrein

protected static Brein getBrein()

recommendation

public static BreinRecommendationResult recommendation(BreinRecommendation data)

recommendation

public static BreinRecommendationResults recommendation(BreinRecommendations data)

lookUp

public static BreinResult lookUp(BreinLookup data)