amplify_api 1.0.0-next.0+2

The Amplify Flutter API category plugin, supporting GraphQL and REST operations.

amplify_api

The Amplify Flutter API category plugin.

Developer Preview

The Amplify Flutter libraries are being rewritten in Dart. This version is part of our developer preview for all platforms and is not intended for production usage. Please follow our Web and Desktop support tickets to monitor the status of supported categories. We will be releasing Web and Desktop support for all Amplify categories incrementally.

For production use cases please use the latest, non-tagged versions of amplify-flutter packages from pub.dev. They offer a stable, production-ready experience for Android and iOS.

Category / Platform Support (Developer Preview)

Category	Android	iOS	Web	Windows	MacOS	Linux
Analytics	[ ]	[X]	[ ]	[ ]	[ ]	[ ]
API (REST)	[X]	[X]	[ ]	[ ]	[ ]	[ ]
API (GraphQL)	[X]	[X]	[ ]	[ ]	[ ]	[ ]
Authentication	[X]	[X]	[X]	[X]	[X]	[X]
DataStore	[X]	[X]	[ ]	[ ]	[ ]	[ ]
Storage	[X]	[X]	[ ]	[ ]	[ ]	[ ]

Getting Started

Visit our Web Site to learn more about AWS Amplify.

Changes for version 0.3.0 and above

When creating subscriptions, now, a Stream object will be returned to you. This Stream will continue producing events until either the subscription encounters an error, or you cancel the subscription. In the case of await for, this cancellation occurs when breaking out of the loop.

Future<void> subscribe() async {
  final graphQLDocument = '''subscription MySubscription {
    onCreateBlog {
      id
      name
      createdAt
    }
  }''';
  final Stream<GraphQLResponse<String>> operation = Amplify.API.subscribe(
    GraphQLRequest<String>(document: graphQLDocument),
    onEstablished: () => print('Subscription established'),
  );

  try {
    // Retrieve 5 events from the subscription
    var i = 0;
    await for (var event in operation) {
      i++;
      print('Subscription event data received: ${event.data}');
      if (i == 5) {
        break;
      }
    }
  } on Exception catch (e) {
    print('Error in subscription stream: $e');
  }
}

Alternatively, you can call Stream.listen to create a StreamSubscription object which can be programmatically canceled.

Future<void> subscribe() async {
  final graphQLDocument = '''subscription MySubscription {
    onCreateBlog {
      id
      name
      createdAt
    }
  }''';
  final Stream<GraphQLResponse<String>> operation = Amplify.API.subscribe(
    GraphQLRequest<String>(document: graphQLDocument),
    onEstablished: () => print('Subscription established'),
  );
  final StreamSubscription<GraphQLResponse<String>> subscription =
      operation.listen(
    (event) {
      print('Subscription event data received: ${event.data}');
    },
    onError: (Object e) => print('Error in subscription stream: $e'),
  );

  // ...

  // Cancel the subscription and close the underlying stream.
  subscription.cancel();
}