- 23 Dec 2023
- 3 Minutes to read
Event Object
- Updated on 23 Dec 2023
- 3 Minutes to read
The Event object helps you create custom events and event parameters in different data types.
Build event
This method allows you to build your Insider event object.
Method Signature
build()
Method Example
insiderExampleEvent.build();
Set tag event
This method returns a new chainable Insider event object in which you can add parameters.
Parameter | Data Type |
---|---|
eventName | String |
Method Signature
tagEvent(eventName: string): Event;
Method Example
// You can create an event without parameters and call the build method;
const event = await window.Insider.tagEvent("event_name").build();
Set string parameter
This method allows you to set the string parameter of your Insider event object.
Parameter | Data Type |
---|---|
key | String |
value | String |
Method Signature
addParameterWithString(key: string, value: string): Event;
Method Example
// You can create an event with parameters and call the build method
const event = await window.Insider.tagEvent("event_name").addParameterWithString('string_parameter','parameter').build();
Set integer parameter
This method allows you to set the integer parameter of your Insider event object.
Parameter | Data Type |
---|---|
key | String |
value | Number |
Method Signature
addParameterWithInt(key: string, value: number): Event;
Method Example
// You can create an event with parameters and call the build method
const event = await window.Insider.tagEvent("event_name").addParameterWithInt('int_parameter', 10).build();
Set double parameter
This method allows you to set the double parameter of your Insider event object.
Parameter | Data Type |
---|---|
key | String |
value | Number |
Method Signature
addParameterWithDouble(key: string, value: number): Event;
Method Example
// You can create an event with parameters and call the build method
const event = await window.Insider.tagEvent("event_name").addParameterWithDouble('double_parameter',10.5).build();
Set date parameter
This method allows you to set the date parameter of your Insider event object.
Parameter | Data Type |
---|---|
key | String |
value | String |
Method Signature
addParameterWithDate(key: string, value: string): Event;
Method Example
// You can create an event with parameters and call the build method
const event = await window.Insider.tagEvent("event_name").addParameterWithDate('date_parameter','parameter').build();
Set array parameter
This method allows you to set the array parameter of your Insider event object.
Parameter | Data Type |
---|---|
key | String |
value | Object |
Method Signature
addParameterWithArray(key: string, value: number): Event;
Method Example
// You can create an event with parameters and call the build method
const arr = ['value1', 'value2', 'value3'];
const event = await window.Insider.tagEvent("event_name").addParameterWithArray('array_parameter',arr).build();
Set boolean parameter
This method allows you to set the boolean parameter of your Insider event object.
Parameter | Data Type |
---|---|
key | String |
value | Boolean |
Method Signature
addParameterWithBoolean(key: string, value: boolean): Event;
Method Example
// You can create an event with parameters and call the build method
const event = await window.Insider.tagEvent("event_name").addParameterWithBoolean('boolean_parameter', true).build();