Context Layer Implementation Guide

Context Methods Reference

addAllCartData

IOS

Android

React-Native

Web

Signature

public func addAllCartData(_ cartLines: [CartLine]?) throws

Description

Sets the complete cart information on the Context object.

Use this method when you want to provide the entire cart state in a single operation.

Refer to the Cart Lines parameters.

Usage Example

let contextObj = ContextObj()
let cartLinesSample = [
            CartLine(sku: "SKU123", pid: "PID123", quantity: 1, currency: "USD", value: "19.99"),
            CartLine(sku: "SKU456", pid: "PID456", quantity: 2, currency: "USD", value: "39.98")
        ]
        do {
            try contextObj.addAllCartData(cartLinesSample)
         } catch {
            print(error.localizedDescription)
         }

Method Signature

public void addAllCartData(CartLine[] cartLines)

Description

Sets the complete cart information on the Context object.

Use this method when you want to provide the entire cart state in a single operation.

Refer to the Cart Lines parameters.

Usage Example

CartLine cartLine1 = new CartLine();
cartLine1.setSku("SKU_1");
cartLine1.setPid("PID_1");
cartLine1.setQuantity(2);
cartLine1.setCurrency("US");
cartLine1.setValue("20");

CartLine cartLine2 = new CartLine();
cartLine2.setSku("SKU_2");
cartLine2.setPid("PID_2");
cartLine2.setQuantity(1);
cartLine2.setCurrency("US");
cartLine2.setValue("10");

Context context = new Context();
context.addAllCartData(new CartLine[] { cartLine1, cartLine2 });

Method Signature

addAllCartData(): {
  cartLines(products: cartLine[]): this;
}

Description

Sets the complete cart information on the Context object.

Use this method when you want to provide the entire cart state in a single operation.

Refer to the Cart Lines parameters.

Usage Example

let context = new Context();

monetateContext.addSingleCartData().product({
            sku: "SKU-123",
            pid: "ddsds",
            productId: "123",
            quantity: 1,
            value: "1999",
            currency: "INR",
        });

Method Signature

addAllCartData(): {
  cartLines(products: cartLine[]): this;
}

Description

Sets the complete cart information on the Context object.

Use this method when you want to provide the entire cart state in a single operation.

Refer to the Cart Lines parameters.

Usage Example

let context = new Context();

monetateContext.addAllCartData().product({
            sku: "SKU-123",
            pid: "ddsds",
            productId: "123",
            quantity: 1,
            value: "1999",
            currency: "INR",
        });

addSingleCartData

Android

IOS

React-Native

Web

Method Signature

public void addSingleCartData(CartLine cartLine)

Description

Sets a single cart item on the Context object.

Use during Add To Cart operations.

Refer to the Cart Lines parameters.

Usage Example

CartLine cartLine = new CartLine();
cartLine.setSku("SKU");
cartLine.setPid("PID");
cartLine.setQuantity(2);
cartLine.setCurrency("US");
cartLine.setValue("20");

Context context = new Context();
context.addSingleCartData(cartLine);

Method Signature

public func addSingleCartData(_ cartLine: CartLine?) throws

Description

Sets a single cart item on the Context object.

Use during Add To Cart operations.

Refer to the Cart Lines parameters.

Usage Example

let contextObj = ContextObj()
let cartLine = CartLine(sku: "sku6", pid: "pid4", quantity: 3, currency: "curr1", value: "21")
        do {
            try contextObj.addSingleCartData(cartLine)
        } catch {
            print(error.localizedDescription)
        }

Notes

All required fields must be populated in the CartLine object

Method Signature

addSingleCartData(): {
  product(product: ProductLine): this;
}

Description

Sets a single cart item on the Context object.

Use during Add To Cart operations.

Refer to the Cart Lines parameters.

Usage Example

let context = new Context();

context
  .addSingleCartData()
  .product({
    sku: "sku-1",
    pid: "parent-1",
    productId: "prod-1",
    quantity: 1,
    value: "50",
    currency: "USD"
  });

Method Signature

addSingleCartData(): {
  product(product: ProductLine): this;
}

Description

Sets a single cart item on the Context object.

Use during Add To Cart operations.

Refer to the Cart Lines parameters.

Usage Example

let context = new Context();

context
  .addSingleCartData()
  .product({
    sku: "sku-1",
    pid: "parent-1",
    productId: "prod-1",
    quantity: 1,
    value: "50",
    currency: "USD"
  });

addCustomVariablesData

Android

IOS

React-Native

Web

Method Signature

public void addCustomVariablesData(CustomVariable[] customVariables)

Description

Sets one or more custom variables for business-specific attributes.

Refer to the Custom variables parameters.

Usage Example

CustomVariable customVariable1 = new CustomVariable();
customVariable1.setVariable("Team A");
customVariable1.setValue("Winning Team");

CustomVariable customVariable2 = new CustomVariable();
customVariable2.setVariable("Team B");
customVariable2.setValue("Losing Team");

Context context = new Context();
context.addCustomVariablesData(
    new CustomVariable[] { customVariable1, customVariable2 }
);

Method Signature

 public func addCustomVariablesData(_ customVariables: [CustomVariablesModel]?) throws

Description

Sets one or more custom variables for business-specific attributes.

Refer to the Custom variables parameters.

Usage Example

let contextObj = ContextObj()
let customVariablesModels = [
            CustomVariablesModel(variable: "userType", value: "premium"),
            CustomVariablesModel(variable: "loyaltyLevel", value: 3)
        ]
        
try? contextObj.addCustomVariablesData(customVariablesModels)

Method Signature

addCustomVariablesData(): {
  variable(variable: string): this;
  value(value: any): this;
}

Description

Sets one or more custom variables for business-specific attributes.

Refer to the Custom variables parameters.

Usage Example

let context = Context()
context
  .addCustomVariablesData()
  .variable("userType")
  .value("premium")
  .variable("cartValue")
  .value(1500)

Method Signature

addCustomVariablesData(): {
  variable(variable: string): this;
  value(value: any): this;
}

Description

Sets one or more custom variables for business-specific attributes.

Refer to the Custom variables parameters.

Usage Example

let context = Context()
context
  .addCustomVariablesData()
  .variable("userType")
  .value("premium")
  .variable("cartValue")
  .value(1500)

addIpAddress

Android

IOS

React-Native

Web

Method Signature

public void addIpAddress(String ipAddress)public func addIpAddress(_ ipAddress: String?) throws

Description

Sets the IP address on the Context object.

Refer to the IPAddress parameters.

Usage Example

Context context = new Context();
context.addIpAddress("1.0.0.0");

Method Signature

public func addIpAddress(_ ipAddress: String?) throws

Description

Sets the IP address on the Context object.

Refer to the IPAddress parameters.

Usage Example

let contextObj = ContextObj()
try? contextObj.addIpAddress("192.168.1.1")

Method Signature

addIpAddress(): {
  ipAddress(ipAddress: string): this;
}

Description

Sets the IP address on the Context object.

Refer to the IPAddress parameters.

Usage Example

const  context = new Context();
context.addIpAddress("1.0.0.0");

Method Signature

addIpAddress(): {
  ipAddress(ipAddress: string): this;
}

Description

Sets the IP address on the Context object.

Refer to the IPAddress parameters.

Usage Example

const  context = new Context();
context.addIpAddress("1.0.0.0");

addMetaData

Android

IOS

React-Native

Web

Method Signature

public void addMetaData(Language language)

Description:-

Sets metadata on the Context object.

Currently used for language context.

Refer to the Meta Data event parameters.

Usage Example

Language language = new Language();
language.setLanguage("EN");

Context context = new Context();
context.addMetaData(language);

Method Signature

 public func addMetaData(language: Language?) throws

Description:-

Sets metadata on the Context object.

Currently used for language context.

Refer to the Meta Data event parameters.

Usage Example

let contextObj = ContextObj()
let language = Language(language: "en-US")

try? contextObj.addMetaData(language: language)

Method Signature

addMetaData(): {
  language(language: string): void;
}

Description:-

Sets metadata on the Context object.

Currently used for language context.

Refer to the Meta Data event parameters.

Usage Example

let contextObj = ContextObj()
let language = Language(language: "en-US")

try? contextObj.addMetaData(language: language)

Method Signature

 public func addMetaData(language: Language?) throws

Description:-

Sets metadata on the Context object.

Currently used for language context.

Refer to the Meta Data event parameters.

Usage Example

let contextObj = ContextObj()
let language = Language(language: "en-US")

try? contextObj.addMetaData(language: language)

addPageDetails

Android

IOS

React-Native

Web

Method Signature :-

public void addPageDetails(
    String pageType,
    String url,
    String[] categories,
    String[] breadcrumbs,
    String path
)

Description

Sets page-level details including pageType, URL/path, categories, and breadcrumbs.

Refer to the Page Detail View event parameters.

Usage Example

Context context = new Context();
context.addPageDetails(
    "home-page",
    "https://example.com",
    new String[] { "category1", "category2" },
    new String[] { "breadcrumb1", "breadcrumb2" },
    "abc/xyz/pqr/testpath"
);

Method Signature :-

let contextObj = ContextObj()
public func addPageDetails(pageType: String, path: String?, url: String?, categories: [String]?, breadcrumbs: [String]?) throws

Description

Sets page-level details including pageType, URL/path, categories, and breadcrumbs.

Refer to the Page Detail View event parameters.

Usage Example

let contextObj = ContextObj()
try? contextObj.addPageDetails(pageType: "home",
 path: "path", 
 url: nil, 
 categories: ["electronics", "sale"], 
 breadcrumbs: ["home", "deals"]
 )

Notes

pageType is mandatory

Either url or path is required

Method Signature :-

addPageDetails(): {
  url(url: string): this;
  path(path: string): this;
  pageType(pageType: string): this;
  breadcrumbs(breadcrumbs: string[]): this;
  categories(categories: string[]): this;
}

Description

Sets page-level details including pageType, URL/path, categories, and breadcrumbs.

Refer to the Page Detail View event parameters.

Usage Example

Context context = new Context();
context
  .addPageDetails()
  .url(window.location.href)
  .path(window.location.pathname)
  .pageType("home")
  .breadcrumbs(["Home"])
  .categories(["Homepage"]);

Method Signature :-

addPageDetails(): {
  url(url: string): this;
  path(path: string): this;
  pageType(pageType: string): this;
  breadcrumbs(breadcrumbs: string[]): this;
  categories(categories: string[]): this;
}

Description

Sets page-level details including pageType, URL/path, categories, and breadcrumbs.

Refer to the Page Detail View event parameters.

Usage Example

Context context = new Context();
context
  .addPageDetails()
  .url(window.location.href)
  .path(window.location.pathname)
  .pageType("home")
  .breadcrumbs(["Home"])
  .categories(["Homepage"]);

addPageEventsData

Android

IOS

React-Native

Web

Method Signature

public void addPageEventsData(String[] pageEventsData)

Description

Sets page event identifiers on the Context object.

Refer to the Page Events parameters.

Usage Example

Context context = new Context();
context.addPageEventsData(new String[] { "eventData1", "eventData2" });

Method Signature

public func addPageEventsData(_ pageEventsData: [String]?) throws

Description

Sets page event identifiers on the Context object.

Refer to the Page Events parameters.

Usage Example

let contextObj = ContextObj()
try? contextObj.addPageEventsData(["pageLoad", 
"buttonClick", 
"formSubmit"])

Method Signature

addPageEventsData(): {
  pageEvents(events: string[]): this ;
}

Description

Sets page event identifiers on the Context object.

Refer to the Page Events parameters.

Usage Example

Context context = new Context();
context
  .addPageEventsData()
  .pageEvents(["click", "banner", "homepage"]);

Method Signature

addPageEventsData(): {
  pageEvents(events: string[]): this ;
}

Description

Sets page event identifiers on the Context object.

Refer to the Page Events parameters.

Usage Example

Context context = new Context();
context
  .addPageEventsData()
  .pageEvents(["click", "banner", "homepage"]);

addProductDetails

Android

IOS

React-Native

Web

Method Signature

public void addProductDetails(Product[] productsData)

Description

Sets product-level details such as productID and SKU.

Refer to the Product Detail View Event parameters.

Usage Example

Product product1 = new Product();
product1.setProductId("PID1");
product1.setSku("SKU1");

Product product2 = new Product();
product2.setProductId("PID2");
product2.setSku("SKU2");

Context context = new Context();
context.addProductDetails(new Product[] { product1, product2 });

Method Signature

public func addProductDetails(_ productsData: [Product]?) throws

Description

Sets product-level details such as productID and SKU.

Refer to the Product Detail View Event parameters.

Usage Example

 let productsSample = [
            Product(productId: "PROD001", sku: "SKU001"),
            Product(productId: "PROD002", sku: "SKU002")
        ]
let contextObj = ContextObj()
try? contextObj.addProductDetails(productsSample)

Method Signature

addProductDetails(): {
  product(product: { sku: string; productId?: string }): this;
}

Description

Sets product-level details such as productID and SKU.

Refer to the Product Detail View Event parameters.

Usage Example

 const context = new Context();

context
  .addProductDetails()
  .productId("123")
  .productSKU("SKU-1");

Method Signature

addProductDetails(): {
  product(product: { sku: string; productId?: string }): this;
}

Description

Sets product-level details such as productID and SKU.

Refer to the Product Detail View Event parameters.

Usage Example

 const context = new Context();

context
  .addProductDetails()
  .productId("123")
  .productSKU("SKU-1");

addProductThumbnailsData

Android

IOS

React-Native

Web

Method Signature

public func addProductThumbnailsData(_ products: [String]?) throws

Description

Sets product thumbnail view data.

Refer to the Product Thumbnails Event parameters.

Usage Example

let contextObj = ContextObj()
try? contextObj.addProductThumbnailsData(["PROD001", "PROD002", "PROD003"])

Method Signature

public func addProductThumbnailsData(_ products: [String]?) throws

Description

Sets product thumbnail view data.

Refer to the Product Thumbnails Event parameters.

Usage Example

let contextObj = ContextObj()
try? contextObj.addProductThumbnailsData(["PROD001", "PROD002", "PROD003"])

Method Signature

addProductThumbnailsData(): {
  product(product: string[]): this;
}

Description

Sets product thumbnail view data.

Refer to the Product Thumbnails Event parameters.

Usage Example

context
  .addProductThumbnailsData()
  .product(["SKU-1", "SKU-2", "SKU-3"]);

Method Signature

addProductThumbnailsData(): {
  product(product: string[]): this;
}

Description

Sets product thumbnail view data.

Refer to the Product Thumbnails Event parameters.

Usage Example

context
  .addProductThumbnailsData()
  .product(["SKU-1", "SKU-2", "SKU-3"]);

addPurchaseData

Android

IOS

React-Native

Web

Method Signature

public void addPurchaseData(String purchaseId, PurchaseLine[] purchaseLineData)

Description

Sets purchase transaction data along with purchased line items.

Refer to the Purchase Event and Purachse Lines parameters.

Usage Example

PurchaseLine purchaseLine = new PurchaseLine();
purchaseLine.setSku("SKU1");
purchaseLine.setPid("PID1");
purchaseLine.setQuantity(2);
purchaseLine.setCurrency("US");
purchaseLine.setValue("23.00");

Context context = new Context();
context.addPurchaseData("1b2c3d", new PurchaseLine[] { purchaseLine });

Method Signature

public func addPurchaseData(purchaseId: String?, purchaseLineData: [PurchaseLine]?) throws

Description

Sets purchase transaction data along with purchased line items.

Refer to the Purchase Event and Purachse Lines parameters.

Usage Example

let purchaseLinesSample: [PurchaseLine] = [
            PurchaseLine(sku: "sku0", pid: "PID123", quantity: 1, currency: "USD", value: "19.99"),
            PurchaseLine(sku: "sku1", pid: "PID456", quantity: 2, currency: "USD", value: "39.98")
        ]
let contextObj = ContextObj()
try? contextObj.addPurchaseData(purchaseId: "purchase123", purchaseLineData: purchaseLinesSample)

Method Signature

addPurchaseData(): {
  purchaseId(purchaseId: string): this;
  purchaseLines(products: ProductLine[]): this;
}

Description

Sets purchase transaction data along with purchased line items.

Refer to the Purchase Event and Purachse Lines parameters.

Usage Example

const context = new Context();

context
  .addPurchaseData()
  .purchaseId("ORDER-123")
  .purchaseLines([
    {
      sku: "SKU-1",
      pid: "P1",
      productId: "123",
      quantity: 2,
      value: "100",
      currency: "USD"
    }
  ]);

Method Signature

addPurchaseData(): {
  purchaseId(purchaseId: string): this;
  purchaseLines(products: ProductLine[]): this;
}

Description

Sets purchase transaction data along with purchased line items.

Refer to the Purchase Event and Purachse Lines parameters.

Usage Example

const context = new Context();

context
  .addPurchaseData()
  .purchaseId("ORDER-123")
  .purchaseLines([
    {
      sku: "SKU-1",
      pid: "P1",
      productId: "123",
      quantity: 2,
      value: "100",
      currency: "USD"
    }
  ]);

addScreenSizeData

Android

IOS

React-Native

Web

Method Signature

public void addScreenSizeData(Integer screenHeight, Integer screenWidth)

Description

Sets screen size information.

Usage Example

Context context = new Context();
context.addScreenSizeData(211, 2313);

Method Signature

public func addScreenSizeData(screenHeight: Int?, screenWidth: Int?)

Description

Sets screen size information.

Refer to the ScreenSize Event parameters.

Usage Example

let contextObj = ContextObj()
try? contextObj.addScreenSizeData(screenHeight: 1000, screenWidth: 400)

Method Signature

addScreenSizeData(): {
  width(width: number): this;
  height(height: number): this;
}

Description

Sets screen size information.

Refer to the ScreenSize Event parameters.

Usage Example

context
  .addScreenSizeData()
  .width(211)
  .height(400);

Method Signature

addScreenSizeData(): {
  width(width: number): this;
  height(height: number): this;
}

Description

Sets screen size information.

Refer to the ScreenSize Event parameters.

Usage Example

context
  .addScreenSizeData()
  .width(211)
  .height(400);

addCoordinatesData

Android

IOS

React-Native

Web

Method Signature

public void addCoordinatesData(String latitude, String longitude)

Description

Sets coordinate (latitude, longitude) data.

Refer to the Coordinate Event parameters.

Usage Example

Context context = new Context();
context.addCoordinatesData("19.0760", "72.8777");

Method Signature

 public func addCoordinatesData(latitude: String?, longitude: String?)

Description

Sets coordinate (latitude, longitude) data.

Usage Example

let contextObj = ContextObj()
try? contextObj.addCoordinatesData(latitude: "37.7749", longitude: "-122.4194")

Method Signature

addCoordinatesData(): {
  latitude(latitude: string): this;
  longitude(longitude: string): this;
}

Description

Sets coordinate (latitude, longitude) data.

Usage Example

Context context = new Context();

context
  .addCoordinatesData()
  .latitude("12.9716")
  .longitude("77.5946");

Method Signature

addCoordinatesData(): {
  latitude(latitude: string): this;
  longitude(longitude: string): this;
}

Description

Sets coordinate (latitude, longitude) data.

Usage Example

Context context = new Context();

context
  .addCoordinatesData()
  .latitude("12.9716")
  .longitude("77.5946");

addUserAgentData

Android

IOS

React-Native

Web

Method Signature

public void addUserAgentData(String data)

Description

Sets user agent / device information.

Refer to the UserAgent Event parameters.

Usage Example

DeviceDetails details = new DeviceDetails();
details.setDevice("device-name-here");
details.setModel("device-model-here");
details.setOsApiLevel("OS-API-level-here");
details.setOsVersion("OS-version-here");
details.setProductName("product-name-here");

String deviceDetails = personalization.refactorDeviceDetails(details);

Context context = new Context();
context.addUserAgentData(deviceDetails);

Method Signature

public func addUserAgentData(_ data: String?) throws

Description

Sets user agent / device information.

Usage Example

  try? contextObj.addUserAgentData("Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Mobile/15E148 Safari/604.1")

Method Signature

addUserAgentData(): {
  userAgent(userAgent: string): this;
}

Description

Sets user agent / device information.

Refer to the UserAgent Event parameters.

Usage Example

Context context = new Context();
context
  .addUserAgentData()
  .userAgent("user-Agent");

Method Signature

addUserAgentData(): {
  userAgent(userAgent: string): this;
}

Description

Sets user agent / device information.

Refer to the UserAgent Event parameters.

Usage Example

Context context = new Context();
context
  .addUserAgentData()
  .userAgent(navigator.userAgent);

Validation & Error Handling

Android

IOS

React-Native

Web

All Context methods validate required inputs before setting data.

If any required field is:

Missing

Null

Empty

the SDK throws an IllegalArgumentException.

try {
    context.addIpAddress("1.0.0.0");
} catch (IllegalArgumentException e) {
    // Handle validation error
}

All Context methods validate required inputs before setting data.

If any required field is:

Missing

Null

Empty

the SDK throws an IllegalArgumentException.

do {
      try contextObj.addIpAddress("1.0.0.0")
} catch {
      // Handle validation error
}

All Context methods validate required inputs before setting data.

If any required field is:

Missing

Null

Empty

the SDK throws an IllegalArgumentException.

try {
    context.addIpAddress("1.0.0.0");
} catch (err) {
    // Handle validation error
}

All Context methods validate required inputs before setting data.

If any required field is:

Missing

Null

Empty

the SDK throws an IllegalArgumentException.

try {
    context.addIpAddress("1.0.0.0");
} catch (err) {
    // Handle validation error
}

Context Layer for Event Data Reporting

The Context Layer allows you to pass event-specific data to the SDK’s reporting methods.

Reporting Cart data

example :-

const account = {
    account: "monetate",
    domain: "monetate",
    name: "a-123445",
    instance: "p",
    shortname: "monetate",
    engineHostName:"host-name"
};
const user = {
    deviceId: "",
    monetateId: Personalization.generateMonetateId(),
    customerId: "customerId",
};

const personalization = new Personalization(user, account);

let context = new Context();

monetateContext.addAllCartData().product({
            sku: "SKU-123",
            pid: "ddsds",
            productId: "123",
            quantity: 1,
            value: "1999",
            currency: "INR",
        });
        
//reporting entire CartData
personalization.reportCartData();

Using Context with getActions()

The getActions method retrieves experience-based actions from the personalization engine.

The Context Layer provides all input signals required by the experience rules (IP, page details, product details, etc.). In Single-Context evaluation only single data is required to satisfy the experience In Multi-Context evaluation multiple data is required to satisy the experience

Example 1: Single-Context Evaluation

const account = {
    account: "monetate",
    domain: "monetate",
    name: "a-123445,
    instance: "p",
    shortname: "monetate",
    engineHostName:"host-name"
};
const user = {
    deviceId: "",
    monetateId: Personalization.generateMonetateId(),
    customerId: "customerId",
};

const personalization = new Personalization(user, account);

//setting data to context
const monetateContext = new Context();
context.addIpAddress("1.0.0.0");

 coreSdkInstance.getActions(
 ["monetate:action:OmnichannelJson"] , monetateContext)
 .then((res: any) => console.log("Action ", res));

Example 2: Multi-Context Evaluation

const account = {
    account: "monetate",
    domain: "monetate",
    name: "a-123445,
    instance: "p",
    shortname: "monetate",
    engineHostName:"host-name"
};
const user = {
    deviceId: "",
    monetateId: Personalization.generateMonetateId(),
    customerId: "customerId",
};

const personalization = new Personalization(user, account);

//setting data to context
const monetateContext = new Context();
context.addIpAddress("1.0.0.0");

monetateContext.addAllCartData().product({
            sku: "SKU-123",
            pid: "ddsds",
            productId: "123",
            quantity: 1,
            value: "1999",
            currency: "INR",
        });
        
 coreSdkInstance.getActions(
 ["monetate:action:OmnichannelJson" ], monetateContext)
 .then((res: any) => console.log("Action ", res));

The SDK evaluates all data present inside the Context object and returns the appropriate actions.