io.puremetrics.sdk

Class PureMetrics.Order.Builder

java.lang.Object

io.puremetrics.sdk.PureMetrics.Order.Builder

Enclosing class:

PureMetrics.Order

public static class PureMetrics.Order.Builder
extends java.lang.Object

Builder class for PureMetrics.Order Object. Provides a convenient way to set the various fields of a PureMetrics.Order and generate associated payload which PureMetrics SDK can process

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PureMetrics.Order.Builder	addMeta(java.util.HashMap<java.lang.String,java.lang.Object> meta) Add any additional information which you want to pass
PureMetrics.Order.Builder	addProduct(java.lang.String productId, java.util.Map<java.lang.String,java.lang.Object> dimensions, long unitPrice, long discountedPrice, int units, java.lang.String currency) Add the product information which is being purchased
PureMetrics.Order	build() Combine all of the options that have been set and return a new PureMetrics.Order object
PureMetrics.Order.Builder	setTransactionId(java.lang.String transactionId) Set The transaction Id for the current transaction

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setTransactionId

public PureMetrics.Order.Builder setTransactionId(java.lang.String transactionId)

Set The transaction Id for the current transaction

Parameters:

transactionId - The transaction id to which the transaction belongs

Returns:

PureMetrics.Order.Builder

addProduct

public PureMetrics.Order.Builder addProduct(java.lang.String productId,
                                            java.util.Map<java.lang.String,java.lang.Object> dimensions,
                                            long unitPrice,
                                            long discountedPrice,
                                            int units,
                                            java.lang.String currency)

Add the product information which is being purchased

Parameters:

productId - The product Id

dimensions - Additional dimensions for the product, like category id, type etc

unitPrice - Unit price for the product

discountedPrice - Discounted Price for the product

units - Number of units of the product being purchased

currency - Optional field required when your transaction currency and product price currency is different

Returns:

PureMetrics.Order.Builder

addMeta

public PureMetrics.Order.Builder addMeta(java.util.HashMap<java.lang.String,java.lang.Object> meta)

Add any additional information which you want to pass

Parameters:

meta - Metadata associated with the revenue event. Example: name, product, category, location etc

Returns:

PureMetrics.Order.Builder

build

public PureMetrics.Order build()

Combine all of the options that have been set and return a new PureMetrics.Order object

Returns:

PureMetrics.Order