Skip to content

Commit ab4a36f

Browse files
author
Travis Sheppard
authored
chore: update platform matrices in READMEs (#2345)
1 parent 4b4439d commit ab4a36f

File tree

8 files changed

+36
-85
lines changed

8 files changed

+36
-85
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ We are iterating and looking for feedback and collaboration, so please [**let us
5858
| Category | Android | iOS | Web | Windows | MacOS | Linux |
5959
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
6060
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
61-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
62-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
61+
| API (REST) ||| | | | |
62+
| API (GraphQL) ||| | | | |
6363
| Authentication |||||||
6464
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
65-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
65+
| Storage ||| | | | |
6666

6767
### To Be Implemented
6868

packages/amplify/amplify_flutter/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1313
| Category | Android | iOS | Web | Windows | MacOS | Linux |
1414
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
1515
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
16-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
17-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
16+
| API (REST) ||| | | | |
17+
| API (GraphQL) ||| | | | |
1818
| Authentication |||||||
1919
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
20-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
20+
| Storage ||| | | | |
2121

2222
## Getting Started
2323

packages/amplify_core/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,12 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1313
| Category | Android | iOS | Web | Windows | MacOS | Linux |
1414
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
1515
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
16-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
17-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
16+
| API (REST) ||| | | | |
17+
| API (GraphQL) ||| | | | |
1818
| Authentication |||||||
1919
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
20-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
20+
| Storage |||||||
21+
22+
## Getting Started
23+
24+
### Visit our [Web Site](https://docs.amplify.aws/) to learn more about AWS Amplify.

packages/amplify_datastore/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1313
| Category | Android | iOS | Web | Windows | MacOS | Linux |
1414
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
1515
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
16-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
17-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
16+
| API (REST) ||| | | | |
17+
| API (GraphQL) ||| | | | |
1818
| Authentication |||||||
1919
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
20-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
20+
| Storage ||| | | | |
2121

2222
## Getting Started
2323

packages/analytics/amplify_analytics_pinpoint/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1010

1111
Please note that the Analytics category is only available on iOS in the developer preview release.
1212

13+
## Category / Platform Support (Developer Preview)
14+
15+
| Category | Android | iOS | Web | Windows | MacOS | Linux |
16+
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
17+
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
18+
| API (REST) |||||||
19+
| API (GraphQL) |||||||
20+
| Authentication |||||||
21+
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
22+
| Storage |||||||
23+
1324
## Getting Started
1425

1526
### Visit our [Web Site](https://docs.amplify.aws/) to learn more about AWS Amplify.

packages/api/amplify_api/README.md

Lines changed: 3 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -13,76 +13,12 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1313
| Category | Android | iOS | Web | Windows | MacOS | Linux |
1414
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
1515
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
16-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
17-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
16+
| API (REST) ||| | | | |
17+
| API (GraphQL) ||| | | | |
1818
| Authentication |||||||
1919
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
20-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
20+
| Storage ||| | | | |
2121

2222
## Getting Started
2323

2424
### Visit our [Web Site](https://docs.amplify.aws/) to learn more about AWS Amplify.
25-
26-
## Changes for version 0.3.0 and above
27-
28-
When creating subscriptions, now, a [`Stream`](https://api.dart.dev/stable/dart-async/Stream-class.html) 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`](https://dart.dev/tutorials/language/streams), this cancellation occurs when breaking out of the loop.
29-
30-
```dart
31-
Future<void> subscribe() async {
32-
final graphQLDocument = '''subscription MySubscription {
33-
onCreateBlog {
34-
id
35-
name
36-
createdAt
37-
}
38-
}''';
39-
final Stream<GraphQLResponse<String>> operation = Amplify.API.subscribe(
40-
GraphQLRequest<String>(document: graphQLDocument),
41-
onEstablished: () => print('Subscription established'),
42-
);
43-
44-
try {
45-
// Retrieve 5 events from the subscription
46-
var i = 0;
47-
await for (var event in operation) {
48-
i++;
49-
print('Subscription event data received: ${event.data}');
50-
if (i == 5) {
51-
break;
52-
}
53-
}
54-
} on Exception catch (e) {
55-
print('Error in subscription stream: $e');
56-
}
57-
}
58-
```
59-
60-
Alternatively, you can call [`Stream.listen`](https://api.dart.dev/stable/dart-async/Stream/listen.html) to create a [`StreamSubscription`](https://api.dart.dev/stable/dart-async/StreamSubscription-class.html) object which can be programmatically canceled.
61-
62-
```dart
63-
Future<void> subscribe() async {
64-
final graphQLDocument = '''subscription MySubscription {
65-
onCreateBlog {
66-
id
67-
name
68-
createdAt
69-
}
70-
}''';
71-
final Stream<GraphQLResponse<String>> operation = Amplify.API.subscribe(
72-
GraphQLRequest<String>(document: graphQLDocument),
73-
onEstablished: () => print('Subscription established'),
74-
);
75-
final StreamSubscription<GraphQLResponse<String>> subscription =
76-
operation.listen(
77-
(event) {
78-
print('Subscription event data received: ${event.data}');
79-
},
80-
onError: (Object e) => print('Error in subscription stream: $e'),
81-
);
82-
83-
// ...
84-
85-
// Cancel the subscription and close the underlying stream.
86-
subscription.cancel();
87-
}
88-
```

packages/auth/amplify_auth_cognito/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1313
| Category | Android | iOS | Web | Windows | MacOS | Linux |
1414
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
1515
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
16-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
17-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
16+
| API (REST) ||| | | | |
17+
| API (GraphQL) ||| | | | |
1818
| Authentication |||||||
1919
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
20-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
20+
| Storage ||| | | | |
2121

2222
## Getting Started
2323

packages/storage/amplify_storage_s3/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ For production use cases please use the latest, non-tagged versions of amplify-f
1313
| Category | Android | iOS | Web | Windows | MacOS | Linux |
1414
| -------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
1515
| Analytics | 🔴 || 🔴 | 🔴 | 🔴 | 🔴 |
16-
| API (REST) ||| 🔴 | 🔴 | 🔴 | 🔴 |
17-
| API (GraphQL) ||| 🔴 | 🔴 | 🔴 | 🔴 |
16+
| API (REST) ||| | | | |
17+
| API (GraphQL) ||| | | | |
1818
| Authentication |||||||
1919
| DataStore ||| 🔴 | 🔴 | 🔴 | 🔴 |
20-
| Storage ||| 🔴 | 🔴 | 🔴 | 🔴 |
20+
| Storage ||| | | | |
2121

2222
## Getting Started
2323

0 commit comments

Comments
 (0)