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.

Important:

You must register your callbacks before initializing the SDK.

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 the Adjust backend. 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.

Session data object

Property	Data type	Description
`Message`	String	The message from the server or the error logged by the SDK.
`Timestamp`	String	The timestamp from the Adjust backend.
`Adid`	String	A unique device identifier provided by Adjust.
`JsonResponse`	Dictionary <string, object>	The JSON object with the response from the server.
`WillRetry`	Boolean	Returned if the session object failed. Indicates whether there will be an attempt to resend the package at a later time.

Success callbacks

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

Dart


AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment);

config.sessionSuccessCallback = (AdjustSessionSuccess sessionSuccessData) {
  print('[Adjust]: Session tracking success!');

  if (sessionSuccessData.message != null) {
    print('[Adjust]: Message: ' + sessionSuccessData.message);
  }
  if (sessionSuccessData.timestamp != null) {
    print('[Adjust]: Timestamp: ' + sessionSuccessData.timestamp);
  }
  if (sessionSuccessData.adid != null) {
    print('[Adjust]: Adid: ' + sessionSuccessData.adid);
  }
  if (sessionSuccessData.jsonResponse != null) {
    print('[Adjust]: JSON response: ' + sessionSuccessData.jsonResponse);
  }
};

Adjust.start(adjustConfig);

Example

In this example, we register a sessionSuccessCallback that prints the timestamp at which the SDK measured the session.

Dart

AdjustConfig myConfig = new AdjustConfig('{Your App Token}', AdjustEnvironment.sandbox);
//...
myConfig.sessionSuccessCallback = (AdjustSessionSuccess sessionSuccessData) {
  print('Session measured at ' + sessionSuccessData.timestamp);
}
//...
Adjust.start(myConfig);

Failure callbacks

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

Dart


AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment);

config.sessionFailureCallback = (AdjustSessionFailure sessionFailureData) {
  print('[Adjust]: Session tracking failure!');

  if (sessionFailureData.message != null) {
    print('[Adjust]: Message: ' + sessionFailureData.message);
  }
  if (sessionFailureData.timestamp != null) {
    print('[Adjust]: Timestamp: ' + sessionFailureData.timestamp);
  }
  if (sessionFailureData.adid != null) {
    print('[Adjust]: Adid: ' + sessionFailureData.adid);
  }
  if (sessionFailureData.willRetry != null) {
    print('[Adjust]: Will retry: ' + sessionFailureData.willRetry.toString());
  }
  if (sessionFailureData.jsonResponse != null) {
    print('[Adjust]: JSON response: ' + sessionFailureData.jsonResponse);
  }
};

Adjust.start(adjustConfig);

Example

In this example, we register an sessionFailureCallback that logs the session failure message.

Dart

AdjustConfig myConfig = new AdjustConfig('{Your App Token}', AdjustEnvironment.sandbox);
//...
myConfig.sessionFailureCallback = (AdjustSessionFailure sessionFailureData) {
  print('Session failure due to ' + sessionFailureData.message);
}
//...
Adjust.start(myConfig);

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 the Adjust backend. 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.

Event data object

Property	Data type	Description
`Message`	String	The message from the server or the error logged by the SDK.
`Timestamp`	String	The timestamp from the Adjust backend.
`Adid`	String	A unique device identifier provided by Adjust.
`JsonResponse`	Dictionary <string, object>	The JSON object with the response from the server.
`EventToken`	String	The event token.
`CallbackId`	String	The custom defined callback ID set on event object.
`WillRetry`	Boolean	Returned if the event object failed. Indicates whether there will be an attempt to resend the package at a later time.

Success callbacks

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

Dart


AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment);

config.eventSuccessCallback = (AdjustEventSuccess eventSuccessData) {
  print('[Adjust]: Event tracking success!');

  if (eventSuccessData.eventToken != null) {
    print('[Adjust]: Event token: ' + eventSuccessData.eventToken);
  }
  if (eventSuccessData.message != null) {
    print('[Adjust]: Message: ' + eventSuccessData.message);
  }
  if (eventSuccessData.timestamp != null) {
    print('[Adjust]: Timestamp: ' + eventSuccessData.timestamp);
  }
  if (eventSuccessData.adid != null) {
    print('[Adjust]: Adid: ' + eventSuccessData.adid);
  }
  if (eventSuccessData.callbackId != null) {
    print('[Adjust]: Callback ID: ' + eventSuccessData.callbackId);
  }
  if (eventSuccessData.jsonResponse != null) {
    print('[Adjust]: JSON response: ' + eventSuccessData.jsonResponse);
  }
};

Adjust.start(adjustConfig);

Example

In this example, we register an eventSuccessCallback that prints the timestamp at which the SDK measured the event.

Dart

AdjustConfig myConfig = new AdjustConfig('{Your App Token}', AdjustEnvironment.sandbox);
//...
myConfig.eventSuccessCallback = (AdjustEventSuccess eventSuccessData) {
  print('Session measured at ' + eventSuccessData.timestamp);
}
//...
Adjust.start(myConfig);

Failure callbacks

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

Dart


AdjustConfig adjustConfig = new AdjustConfig(yourAppToken, environment);

config.eventFailureCallback = (AdjustEventFailure eventFailureData) {
  print('[Adjust]: Event tracking failure!');

  if (eventFailureData.eventToken != null) {
    print('[Adjust]: Event token: ' + eventFailureData.eventToken);
  }
  if (eventFailureData.message != null) {
    print('[Adjust]: Message: ' + eventFailureData.message);
  }
  if (eventFailureData.timestamp != null) {
    print('[Adjust]: Timestamp: ' + eventFailureData.timestamp);
  }
  if (eventFailureData.adid != null) {
    print('[Adjust]: Adid: ' + eventFailureData.adid);
  }
  if (eventFailureData.callbackId != null) {
    print('[Adjust]: Callback ID: ' + eventFailureData.callbackId);
  }
  if (eventFailureData.willRetry != null) {
    print('[Adjust]: Will retry: ' + eventFailureData.willRetry.toString());
  }
  if (eventFailureData.jsonResponse != null) {
    print('[Adjust]: JSON response: ' + eventFailureData.jsonResponse);
  }
};

Adjust.start(adjustConfig);

Example

In this example, we register an eventFailureCallback that logs the event failure message.

Dart

AdjustConfig myConfig = new AdjustConfig('{Your App Token}', AdjustEnvironment.sandbox);
//...
myConfig.eventFailureCallback = (AdjustEventFailure eventFailureData) {
  print('Session failure due to ' + eventFailureData.message);
}
//...
Adjust.start(myConfig);