Class AmplitudeCookie

This class provides utility functions for parsing and handling identity from Amplitude cookies.

Hierarchy

AmplitudeCookie

Index

Constructors

Methods

cookieName generate parse

Constructors

constructor

new AmplitudeCookie(): AmplitudeCookie
Returns AmplitudeCookie

Methods

`Static` cookieName

cookieName(amplitudeApiKey: string, newFormat?: boolean): string
Returns
The cookie name that Amplitude sets for the provided Amplitude API Key
Parameters
- amplitudeApiKey: string
  
  The Amplitude API Key
- newFormat: boolean = false
  
  True if the cookie is in the Browser SDK 2.0 format
Returns string

`Static` generate

generate(deviceId: string, newFormat?: boolean): string
Generates a cookie string to set for the Amplitude Javascript SDK

Returns
A cookie string to set for the Amplitude Javascript SDK to read
Parameters
- deviceId: string
  
  A device id to set
- newFormat: boolean = false
  
  True if the cookie is in the Browser SDK 2.0 format
Returns string

`Static` parse

parse(amplitudeCookie: string, newFormat?: boolean): ExperimentUser
Returns
a ExperimentUser context containing a device_id and user_id (if available)
Parameters
- amplitudeCookie: string
  
  A string from the amplitude cookie
- newFormat: boolean = false
  
  True if the cookie is in the Browser SDK 2.0 format
Returns ExperimentUser