Skip to content

Commit 6fc673f

Browse files
authored
add check for announcement support per platform (flutter#166099)
<!-- Thanks for filing a pull request! Reviewers are typically assigned within a week of filing a request. To learn more about code review, see our documentation on Tree Hygiene: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md --> Helps unblock flutter#165531 and is part of flutter#165510 *If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].* ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
1 parent ca37883 commit 6fc673f

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

packages/flutter/lib/src/semantics/semantics_service.dart

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ library;
77

88
import 'dart:ui' show TextDirection;
99

10+
import 'package:flutter/foundation.dart';
1011
import 'package:flutter/services.dart' show SystemChannels;
1112

1213
import 'semantics_event.dart' show AnnounceSemanticsEvent, Assertiveness, TooltipSemanticsEvent;
@@ -33,6 +34,9 @@ abstract final class SemanticsService {
3334
/// Currently, this is only supported by the web engine and has no effect on
3435
/// other platforms. The default mode is [Assertiveness.polite].
3536
///
37+
/// Not all platforms support announcements. Check to see if
38+
/// [isAnnounceSupported] before calling this method.
39+
///
3640
/// ### Android
3741
/// Android has [deprecated announcement events][1] due to its disruptive
3842
/// behavior with TalkBack forcing it to clear its speech queue and speak the
@@ -62,4 +66,12 @@ abstract final class SemanticsService {
6266
final TooltipSemanticsEvent event = TooltipSemanticsEvent(message);
6367
await SystemChannels.accessibility.send(event.toMap());
6468
}
69+
70+
/// Checks if announce is supported on the given platform.
71+
///
72+
/// On Android the announce method is deprecated, therefore will return false.
73+
/// On other platforms, this will return true.
74+
static bool isAnnounceSupported() {
75+
return defaultTargetPlatform != TargetPlatform.android;
76+
}
6577
}

packages/flutter/test/semantics/semantics_service_test.dart

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5+
import 'package:flutter/foundation.dart';
56
import 'package:flutter/semantics.dart';
6-
import 'package:flutter/services.dart' show SystemChannels;
7+
import 'package:flutter/services.dart' show SystemChannels, TargetPlatform;
78
import 'package:flutter_test/flutter_test.dart';
89

910
void main() {
@@ -44,4 +45,12 @@ void main() {
4445
]),
4546
);
4647
});
48+
49+
for (final TargetPlatform platform in TargetPlatform.values) {
50+
test('Announce not supported on Android. (platform=$platform)', () {
51+
debugDefaultTargetPlatformOverride = platform;
52+
expect(SemanticsService.isAnnounceSupported(), platform != TargetPlatform.android);
53+
debugDefaultTargetPlatformOverride = null;
54+
});
55+
}
4756
}

0 commit comments

Comments
 (0)