com.bazaarvoice.bvandroidsdk

Class BVSDK

java.lang.Object

com.bazaarvoice.bvandroidsdk.BVSDK

public class BVSDK
extends java.lang.Object

Main class for initializing the Bazaarvoice SDK, and changing global SDK state.

Must initialize the SDK upon Application startup with the BVSDK.Builder.build() method.

API keys for Shopper Advertising and Conversation must be provided to the BVSDK.Builder.apiKeyShopperAdvertising(String) and BVSDK.Builder.apiKeyConversations(String) methods respectively for each of the desired components to function

Your client name and the application object must also be provided when constructing the BVSDK.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BVSDK.Builder Initialization Builder that must be called in the Application.onCreate() method before any Bazaarvoice SDKs can be used.

Method Summary

Modifier and Type	Method and Description
static BVSDK.Builder	builder(android.app.Application application, BazaarEnvironment bazaarEnvironment) Uses the configuration file generated at the installation and configuration page to set all of the options for the sdk.
static BVSDK.Builder	builder(android.app.Application application, java.lang.String clientId) Deprecated. Now use builder(Application, BazaarEnvironment)
static BVSDK.Builder	builderWithConfig(android.app.Application application, BazaarEnvironment bazaarEnvironment, BVConfig bvConfig)
static BVSDK	getInstance()
void	setUserAuthString(java.lang.String userAuthString) Tell BVSDK who the user is.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BVSDK getInstance()

setUserAuthString

public void setUserAuthString(java.lang.String userAuthString)

Tell BVSDK who the user is. This is the essential step in providing targeted, personalized information about the user.

Parameters:

userAuthString - The Bazaarvoice-specific User Auth String. See the online documentation for information on where this auth string comes from, and why it is necessary.

builder

public static BVSDK.Builder builder(android.app.Application application,
                                    java.lang.String clientId)

Deprecated. Now use builder(Application, BazaarEnvironment)

Parameters:

application - Application Object

clientId - Your Bazaarvoice provided client id (e.g. "mycompany")

Returns:

Builder to configure other options

See Also:

builder(Application, BazaarEnvironment)

builder

public static BVSDK.Builder builder(android.app.Application application,
                                    BazaarEnvironment bazaarEnvironment)

Uses the configuration file generated at the installation and configuration page to set all of the options for the sdk.

Parameters:

application - The application object

bazaarEnvironment - The environment that will be used for Bazaarvoice requests

Returns:

Builder to configure other options

builderWithConfig

public static BVSDK.Builder builderWithConfig(android.app.Application application,
                                              BazaarEnvironment bazaarEnvironment,
                                              BVConfig bvConfig)