Creating links

Lander.createLink creates a Lander short link from the app, for example when someone taps Share on a product or Invite a friend. The link works like one made in the dashboard: it opens your app on the right screen, or sends people without the app to the store or your website.

Create a linkCopy Anchor Link

import 'package:flutter/services.dart';
import 'package:lander_flutter/lander_flutter.dart';

Future<void> shareProduct(BuildContext context, String id, String name) async {
  final messenger = ScaffoldMessenger.of(context);
  try {
    final link = await Lander.createLink(
      path: '/product/$id',
      params: {'productId': id},
      title: name,
      channel: 'share',
    );
    await Clipboard.setData(ClipboardData(text: link.url.toString()));
    messenger.showSnackBar(SnackBar(content: Text('Copied ${link.url}')));
  } on LanderException catch (e) {
    messenger.showSnackBar(SnackBar(content: Text('Could not create a link: ${e.message}')));
  }
}

link.url is the shareable URL, for example https://acme.golander.link/x7Kp2Qa. Hand it to the share sheet package you already use, or copy it as above.

When someone opens that link, your app receives a LanderLink with path == '/product/123' and params == {'productId': '123'}. See Receiving links.

ParametersCopy Anchor Link

static Future<LanderShortLink> createLink({
  String path = '/',
  Map<String, Object> params = const {},
  String? title,
  String? campaign,
  String? channel,
  List<String> tags = const [],
  Uri? iosFallbackUrl,
  Uri? androidFallbackUrl,
  Uri? webFallbackUrl,
  String? ogTitle,
  String? ogDescription,
  Uri? ogImageUrl,
  DateTime? expiresAt,
})

What you cannot choose from the app:

• The slug is always random (7 characters).
• The domain is the project's default domain.
• The environment follows the key: a pk_test_ key creates test links, a pk_live_ key creates live links.

The resultCopy Anchor Link

createLink returns a LanderShortLink:

toString() returns the URL, so 'Check this out: $link' reads naturally.

ErrorsCopy Anchor Link

createLink checks two things before it sends anything, and throws an ArgumentError when:

• path does not start with /.
• A params value is not a String, num or bool.

Everything else is checked by the API. Failures throw a LanderException:

e.isRetryable is true for network errors, timeouts, 408, 429 and 5xx responses.

Retries never create two linksCopy Anchor Link

The SDK retries network errors, timeouts, 408, 429 and 5xx responses up to 3 attempts in total, with a short backoff (and waits at least as long as a Retry-After header asks). Every attempt carries the same Idempotency-Key, and Lander replays the first successful response for a repeated key, so a retry after a lost response returns the same link instead of creating a second one.

The install ID is sent along, which is how the API applies the per install rate limit.

Next stepsCopy Anchor Link