Set up callbacks

Set up callbacks to trigger functions when the SDK sends information to Adjust. You can set up callbacks for sessions and events.

Session callbacks

Set up session callbacks to trigger functions when the SDK sends session information. You can create success callbacks and failure callbacks. Success callbacks trigger when the SDK sends information to Adjust’s servers. Failure callbacks trigger when the SDK encounters a problem while sending the information.

Session callbacks have access to a response data object. You can use its properties in your callback function.

Property	Data type	Description
`message`	`string`	The message from the server or the error logged by the SDK.
`timestamp`	`string`	The timestamp from Adjust’s servers.
`adid`	`string`	A unique device identifier provided by Adjust.
`jsonResponse`	`object<string, object>`	The JSON object with the response from the server.
`willRetry`	`boolean`	Indicates whether there will be an attempt to resend a failed package.

Success callbacks

public setSessionTrackingSucceededCallbackListener(
   callback: (sessionSuccess: AdjustSessionTrackingSuccess) => void
): void

Set up success callbacks to trigger functions when the SDK records a session.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setSessionTrackingSucceededCallbackListener(
7
   function (sessionSuccess) {
8
      // Printing all session success properties.
9
      console.log("Session recording succeeded!");
10
      console.log(sessionSuccess.message);
11
      console.log(sessionSuccess.timestamp);
12
      console.log(sessionSuccess.adid);
13
      console.log(sessionSuccess.jsonResponse);
14
   },
15
);
16

17
Adjust.create(adjustConfig);

Example

This example shows how to create a callback function sessionSuccess and register it as a success callback. The function logs the timestamp at which the SDK recorded the session.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setSessionTrackingSucceededCallbackListener(
7
   function (sessionSuccess) {
8
      console.log(sessionSuccess.timestamp);
9
   },
10
);
11

12
Adjust.create(adjustConfig);

Failure callbacks

public setSessionTrackingFailedCallbackListener(
   callback: (sessionFailed: AdjustSessionTrackingFailure) => void
): void

Set up failure callbacks to trigger functions when the SDK fails to record a session.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setSessionTrackingFailedCallbackListener(
7
   function (sessionFailure) {
8
      // Printing all session failure properties.
9
      console.log("Session recording failed!");
10
      console.log(sessionFailure.message);
11
      console.log(sessionFailure.timestamp);
12
      console.log(sessionFailure.adid);
13
      console.log(sessionFailure.willRetry);
14
      console.log(sessionFailure.jsonResponse);
15
   },
16
);
17

18
Adjust.create(adjustConfig);

Example

This example shows how to create a callback function sessionFailure and register it as a failure callback. The function logs the session failure message.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setSessionTrackingFailedCallbackListener(
7
   function (sessionFailure) {
8
      console.log(sessionFailure.message);
9
   },
10
);
11

12
Adjust.create(adjustConfig);

Event callbacks

Set up event callbacks to trigger functions when the SDK sends event information. You can create success callbacks and failure callbacks. Success callbacks trigger when the SDK sends information to Adjust’s servers. Failure callbacks trigger when the SDK encounters a problem while sending the information.

Event callbacks have access to a response data object. You can use its properties in your callback function.

Property	Data type	Description
`message`	`string`	The message from the server or the error logged by the SDK.
`timestamp`	`string`	The timestamp from Adjust’s servers.
`adid`	`string`	A unique device identifier provided by Adjust.
`eventToken`	`string`	The event token
`callbackId`	`string`	The custom callback ID set on the event object
`jsonResponse`	`object<string, object>`	The JSON object with the response from the server.
`willRetry`	`boolean`	Indicates whether there will be an attempt to resend a failed package.

Success callbacks

public setEventTrackingSucceededCallbackListener(
   callback: (eventSuccess: AdjustEventTrackingSuccess) => void
): void

Set up success callbacks to trigger functions when the SDK records an event.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
7
   // Printing all event success properties.
8
   console.log("Event recording succeeded!");
9
   console.log(eventSuccess.message);
10
   console.log(eventSuccess.timestamp);
11
   console.log(eventSuccess.eventToken);
12
   console.log(eventSuccess.callbackId);
13
   console.log(eventSuccess.adid);
14
   console.log(eventSuccess.jsonResponse);
15
});
16

17
Adjust.create(adjustConfig);

Example

This example shows how to create a callback function eventSuccess and register it as a success callback. The function logs the timestamp at which the SDK recorded the event.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setEventTrackingSucceededCallbackListener(function (eventSuccess) {
7
   console.log(eventSuccess.timestamp);
8
});
9

10
Adjust.create(adjustConfig);

Failure callbacks

public setEventTrackingFailedCallback(
   callback: (eventFailed: AdjustEventTrackingFailure) => void
): void

Set up failure callbacks to trigger functions when the SDK fails to record an event.

1
const adjustConfig = new AdjustConfig(
2
   "{Your App Token}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
6
adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
7
   // Printing all event failure properties.
8
   console.log("Event recording failed!");
9
   console.log(eventFailure.message);
10
   console.log(eventFailure.timestamp);
11
   console.log(eventFailure.eventToken);
12
   console.log(eventFailure.callbackId);
13
   console.log(eventFailure.adid);
14
   console.log(eventFailure.willRetry);
15
   console.log(eventFailure.jsonResponse);
16
});
17

18
Adjust.create(adjustConfig);

Example

This example shows how to create a callback function eventFailure and register it as a failure callback. The function logs the event failure message.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setEventTrackingFailedCallbackListener(function (eventFailure) {
7
   console.log(eventFailure.message);
8
});
9

10
Adjust.create(adjustConfig);