SDK setup requirements

To set up the RudderStack Flutter SDK, the prerequisites are as mentioned below:

• You will need to set up a RudderStack Account.
• Once signed up, set up a Flutter source in the dashboard. For more information, see Adding a source. You should then see a Write Key for this source, as shown:

• You will also need a data plane URL. Follow this section for more information on the data plane URL and where to get it.

• We also recommend setting up the Flutter development environment on your system.

Installing the Flutter SDK

The recommended way to install the Flutter SDK is through pub.

To add the SDK as a dependency, perform the following steps:

• Open pubspec.yaml and add rudder_sdk_flutter under dependencies section:

Copy
dependencies:
  rudder_sdk_flutter: ^1.0.5

• Navigate to your Application's root folder and install all the required dependencies with:

Copy
flutter pub get

Initializing the RudderStack client

After adding the SDK as a dependency, you need to set up the SDK.

• To import the SDK, refer to the following snippet:

Copy
import 'package:rudder_sdk_flutter/RudderClient.dart';
import 'package:rudder_sdk_flutter/RudderConfig.dart';
import 'package:rudder_sdk_flutter/RudderLogger.dart';

• Add the following code somewhere in your application.

Copy
RudderLogger.init(RudderLogger.VERBOSE);
RudderConfigBuilder builder = RudderConfigBuilder();
builder.withDataPlaneUrl(DATA_PLANE_URL);
builder.withTrackLifecycleEvents(true);
RudderClient.getInstance(WRITE_KEY,config: builder.build());

The setup method has the following signature:

Check the Configuring your RudderStack client section below for a full list of the configurable parameters.

Track

You can record the users' activity through the track method. Every action performed by the user is called an event.

A sample track event is shown below:

Copy
RudderProperty property = RudderProperty();
property.put("test_key_1", "test_key_1");
RudderProperty childProperty = RudderProperty();
childProperty.put("test_child_key_1", "test_child_value_1");
property.put("test_key_2",childProperty);
RudderClient.track("test_track_event", properties: property);

The track method has the following signature:

Identify

We capture the deviceId and use that as the anonymousId for identifying the user. This helps to track the users across the application installation. To attach more information to the user, you can use the identify method. Once a user is identified, the SDK persists all the user information and passes it to the successive track or screen calls. To reset the user identification, you can use the reset method.

A sample identify event is as shown:

Copy
RudderTraits traits = RudderTraits();
traits.putBirthdayDate(new DateTime.now());
traits.putEmail("abc@123.com");
traits.putFirstName("First");
traits.putLastName("Last");
traits.putGender("m");
traits.putPhone("5555555555");

Address address = Address();
address.putCity("City");
address.putCountry("USA");
traits.putAddress(address);

traits.put("boolean", true);
traits.put("integer", 50);
traits.put("float", 120.4);
traits.put("long", 1234);
traits.put("string", "hello");
traits.put("date", new DateTime.now().millisecondsSinceEpoch);

RudderClient.identify("test_user_id", traits: traits, options: null);

The identify method has the following signature:

Screen

You can use the screen call to record whenever the user sees a screen on the mobile device. You can also send some extra properties along with this event.

An example of the screen event is as shown:

Copy
RudderProperty screenProperty = new RudderProperty();
screenProperty.put("foo", "bar");
RudderClient.screen("Main Activity",
    properties: screenProperty, options: null);

The screen method has the following signature:

Group

The group call associates a user to a specific organization.

An example of group event is as shown:

Copy
RudderTraits groupTraits = RudderTraits();
groupTraits.put("foo", "bar");
groupTraits.put("foo1", "bar1");
RudderClient.group("sample_group_id",
    groupTraits: groupTraits, options: null);

The group method has the following signature:

Alias

The alias call lets you merge different identities of a known user.

A sample alias call is as shown:

Copy
RudderClient.alias("new_user_id", options: null);

The alias method has the following signature:

RudderStack replaces the old userId with the newUserId and persists that identification across the sessions.

Reset

You can use the reset method to clear the persisted traits for the identify call. This is required for Logout operations.

Copy
RudderClient.reset();

Enabling/disabling user tracking via the optOut API (GDPR Support)

RudderStack gives the users (e.g., an EU user) the ability to opt out of tracking any user activity until the user gives their consent. You can do this by leveraging RudderStack's optOut API.

The optOut API takes true or false as a Boolean value to enable or disable tracking user activities. This flag persists across device reboots.

The following snippet highlights the use of the optOut API to disable user tracking:

Copy
RudderClient.optOut(true);

Once the user grants their consent, you can enable user tracking once again by using the optOut API with false as a parameter sent to it, as shown:

Copy
RudderClient.optOut(false);

Enabling/disabling events for specific destinations

The Flutter SDK lets you enable or disable sending events to a specific destination or all the destinations connected to a source. You can specify these destinations by creating an object as shown in the following snippet:

Copy
RudderOption options = new RudderOption();
// default value for `All` is true
options.putIntegration("All", false);
// specifying destination by its display name
options.putIntegration("Mixpanel", false);
// specifying destination by its Factory object
options.putIntegrationWithFactory(Appcenter(), true);

You can pass the destination(s) specified in the above snippet to the SDK in two ways:

1. Passing destinations while initializing the SDK

This is helpful when you want to enable/disable sending the events across all the event calls made using the SDK to the specified destination(s).

Copy
RudderClient.getInstance(WRITE_KEY,
                    config: builder.build(),options: options);

2. Passing destinations while making event calls

This approach is helpful when you want to enable/disable sending only a particular event to the specified destination(s) or if you want to override the specified destinations passed with the SDK initialization for a particular event.

Copy
RudderProperty property = RudderProperty();
property.put("test_key_1", "test_key_1");
RudderClient.track("test_track_event", properties: property, options: options);

External ID

You can pass your custom userId along with standard userId in your identify calls. We add those values under context.externalId. The following code snippet shows a way to add externalId to your identify request.

Copy
RudderOption option = RudderOption();
option.putExternalId("externalId", "some_external_id_1");
RudderClient.identify("testUserId", options: option);

Anonymous ID

We use the deviceId as anonymousId by default. You can use the following method to override and use your own anonymousId with the SDK.

An example of setting the anonymousId is as below

Copy
RudderClient.putAnonymousId(<ANONYMOUS_ID>);

Advertising ID

You can use the putAdvertisingId method to pass your Android and iOS AAID and IDFA respectively. The putAdvertisingId method accepts a string argument :

• id : Your Android advertisingId (AAID) or your iOS advertisingId (IDFA).

An example of how to use putAdvertisingId is as shown:

Copy
RudderClient.putAdvertisingId(<ADVERTISING_ID>);

Setting the device token

You can pass your device-token for push notifications to be passed to the destinations which support the Push Notification feature. We set the token under context.device.token.

An example of setting the device-token is as below:

Copy
RudderClient.putDeviceToken(<DEVICE_TOKEN>);

Configuring your RudderStack client

You can configure your client based on the following parameters by passing them in the RudderConfigBuilder object of your RudderClient.getInstance() call.

Self-hosted control plane

If you are using a device mode destination like Adjust, Firebase, etc., the Flutter SDK needs to fetch the required configuration from the control plane. If you are using the Control Plane Lite utility to host your own control plane, then follow this guide and specify controlPlaneUrl in your RudderConfig.Builder that points to your hosted source configuration file.

Debugging

If you run into any issues regarding the RudderStack Flutter SDK, you can turn on the VERBOSE or DEBUG logging to find out what the issue is.

First, make sure you import RudderLogger with the below command:

Copy
import 'package:rudder_sdk_flutter/RudderLogger.dart';

Then to turn on the logging, change your RudderClient initialization to the following:

Copy
RudderConfigBuilder builder = RudderConfigBuilder();
builder.withDataPlaneUrl(DATA_PLANE_URL);
builder.withLogLevel(RudderLogger.VERBOSE);
RudderClient.getInstance(WRITE_KEY,
                          config: builder.build());

You can set the log level to one of the following values:

1. NONE
2. ERROR
3. WARN
4. INFO
5. DEBUG
6. VERBOSE

FAQs

How do I get the user traits after making an identify call?

You can get the user traits after making an identify call in the following way:

Copy
Map context = await RudderClient.getRudderContext();
print(context["traits"]);

Contact us

For queries on any of the sections covered in this guide, you can contact us or start a conversation in our Slack community.

If you come across any issues while using the Flutter SDK, you can also open an issue on our GitHub Issues page.