com.zaius.androidsdk

Class Zaius

java.lang.Object

com.zaius.androidsdk.Zaius

public class Zaius
extends java.lang.Object

Zaius SDK API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Zaius.GoogleApiChecker

Method Summary

Modifier and Type	Method and Description
void	anonymize() Anonymize (log out).
static Zaius	getInstance()
void	pushOpened(android.os.Bundle bundle) Signal to Zaius that push has been opened.
void	pushOpened(RemoteMessage remoteMessage) Signal to Zaius that push has been opened.
void	sendAddToCart(java.lang.String productId, int quantity) Send an add to cart event, which is a kind of product event.
void	sendDetail(java.lang.String productId) Send a detail event, which is a kind of product event.
void	sendEvent(ZaiusEvent event) Queue the given event to be sent to its associated endpoint.
void	sendRemoveFromCart(java.lang.String productId, int quantity) Send a remove from cart event, which is a kind of product event.
void	setAdvertisingId(java.lang.String advertisingId) Removes the previous advertising ID and sets a new one both here and in preferences.
void	setCustomerId(java.lang.String customerId) Set the customer ID.
static Zaius	start(android.content.Context context, java.lang.String trackerId, java.lang.String applicationId, ZaiusConfig config) Initialize Zaius SDK for token / push activity tracking.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Zaius getInstance()
                         throws ZaiusException

Throws:

ZaiusException

start

public static Zaius start(android.content.Context context,
                          java.lang.String trackerId,
                          java.lang.String applicationId,
                          ZaiusConfig config)
                   throws ZaiusException

Initialize Zaius SDK for token / push activity tracking.

Parameters:

context - application context

trackerId - Zaius tracker ID

applicationId - app ID registered in Zaius Integrations page

config - Zaius configuration, includes ZaiusEnvironment (ZaiusEnvironment.PRODUCTION unless account lives elsewhere)

Throws:

ZaiusException - if invalid parameters passed in

anonymize

public void anonymize()

Anonymize (log out). Future events, the push token, and advertising ID will be associated with the new anonymous user.

sendAddToCart

public void sendAddToCart(java.lang.String productId,
                          int quantity)

Send an add to cart event, which is a kind of product event.

Parameters:

productId - The product ID

quantity - The quantity added to the cart

sendDetail

public void sendDetail(java.lang.String productId)

Send a detail event, which is a kind of product event.

Parameters:

productId - The product ID

sendRemoveFromCart

public void sendRemoveFromCart(java.lang.String productId,
                               int quantity)

Send a remove from cart event, which is a kind of product event.

Parameters:

productId - The product ID

quantity - The quantity removed from the cart

sendEvent

public void sendEvent(ZaiusEvent event)
               throws ZaiusException

Queue the given event to be sent to its associated endpoint.

Parameters:

event - the event

Throws:

ZaiusException

setCustomerId

public void setCustomerId(java.lang.String customerId)
                   throws ZaiusException

Set the customer ID. This will register the device to this user, and unregister it from any previously registered customer.

Parameters:

customerId - client customer ID (null if disassociating previous customer ID from this app installation)

Throws:

ZaiusException

setAdvertisingId

public void setAdvertisingId(java.lang.String advertisingId)

Removes the previous advertising ID and sets a new one both here and in preferences.

Parameters:

advertisingId - the new advertising ID

pushOpened

public void pushOpened(android.os.Bundle bundle)
                throws ZaiusException

Signal to Zaius that push has been opened.

Parameters:

bundle - notification bundle

Throws:

ZaiusException

pushOpened

public void pushOpened(RemoteMessage remoteMessage)
                throws ZaiusException

Signal to Zaius that push has been opened.

Parameters:

remoteMessage - the message returned from FCM

Throws:

ZaiusException - missing key or key points to empty string