Jiny Android SDK Callbacks(Optional)

Jiny Callbacks Initialisation

You can listen to the events provided by Jiny SDK using the following method. (Make sure to call this method after you have initialised Jiny)

JinySDK.setJinyEventListener(new JinyEventListener() {
 @Override
 public void onEvent(String eventName, Map<String, String> eventData) {
 }
});

For React Native Callbacks initialisation, Refer the integration in react native section here.

Jiny provides a list of events regarding its usage. Below is an exhaustive list:

Event Name	Description	Event Data
jiny_ab_event	Details of pilot mode and experiment code. It will be emitted just after the initialisation	{ "jiny_pilot_mode": "", "experiment_code":"" }
jiny_trigger_event	Details of Jiny discovery event. It will be emitted whenever Jiny prompt appears	{ "trigger_name": "", "jiny_lang": "", "discovery_state":"", "prompt_type":"", "jiny_pilot_mode": "", "experiment_code":"" }
jiny_trigger_opt_in_event	Details of user's interaction with Jiny discovery. It will be emitted when the user opt's in or opt's out of Jiny prompt.	{ "trigger_name": "", "jiny_lang": "", "jiny_opt_in":"" "prompt_type":"", "jiny_pilot_mode": "", "experiment_code":"" }
jiny_flow_opt_in_event	Details of the flow which user has opted in. It will be emitted when the user has opted Jiny and starts Jiny guidance.	{ "flow_name": "", "jiny_lang": "", "jiny_pilot_mode": "", "experiment_code":"" }
jiny_stop_event	It will be emitted when user has stopped Jiny guidance.	{ "flow_name": "", "jiny_lang": "", "jiny_pilot_mode": "", "experiment_code":"" }
jiny_page_event	The details of page detected by Jiny.	{ "flow_name": "" "jiny_page_name": "", "jiny_lang": "", "jiny_pilot_mode": "", "experiment_code":"", "jiny_state":"" }
jiny_instruction_event	The details of instruction played by Jiny	{ "flow_name": "" "jiny_instruction": "", "jiny_lang": "", "jiny_pilot_mode": "", "experiment_code":"" }
jiny_activity_event	To know if Jiny Panel is open	{ "is_panel_open": "" }
jiny_dismiss_icon_event	To know if Jiny icon is dismissed	{ "is_icon_dismissed":"" }

Event Data Table

S.No.	Event Data Key	Event Data Value	Description
1	jiny_pilot_mode	1.JINY_BUCKET 2.NON_JINY_BUCKET	The A/B bucket which the user falls into
2	experiment_code	eg- 1, 2 or 3	The experiment which the user falls into
3	trigger_name	eg- buy_product_trigger	Name of the trigger
4	jiny_opt_in	1.true 2.false	To check whether the user has opted Jiny or not.
5	discovery_state	1.AUTO_DISCOVERY 2.MANUAL_DISCOVERY 3.NO_DISCOVERY	1.AUTO_DISCOVERY: When the user is automatically prompted to opt-in for the assistance 2.MANUAL_DISCOVERY: When the user clicks on the Jiny icon to trigger Jiny's prompt 3.NO_DISCOVERY: When the discovery context is detected but no prompt happened
6	prompt_type	eg- FORCE_DISCOVERY	Conveys the kind of prompt
7	flow_name	eg- buy_product_flow	Name of the flow being used
8	jiny_state	1.ACTIVE 2.PASSIVE	In the Jiny bucket, it conveys whether Jiny is on (actively guiding) or it is turned off
9	jiny_page_name	eg- page_flight_details	The name of the page where the user is at
10	jiny_lang	eg- ang / hin	The language of Jiny's guidance. Find supported locales here.
11	jiny_instruction	eg - search_product	The name of the Jiny instruction
12	is_panel_open	true / false	When Jiny's Bottom panel is open
13	is_icon_dismissed	true / false	If Jiny icon is dismissed or not. i.e, whether Jiny assistant is disabled or not. (Note:- This event is triggered only if Jiny dismiss feature is enabled)