Skip to content

Commit 40ba423

Browse files
authored
Merge pull request pusher#46 from pusher/getInitialMessage-doc-clarification
added info key getInitialMessage docs
2 parents b1d08ff + a4b564d commit 40ba423

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/pusher_beams/lib/pusher_beams.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ class PusherBeams extends PusherBeamsPlatform with CallbackHandlerApi {
3030
/// This is intended to be a singleton
3131
static PusherBeams get instance => _instance;
3232

33-
/// Gets any data associated to a Push Notification when opening the app by
34-
/// taping on it.
33+
/// Reads the [info] key included in a Push Notification when opening the app
34+
/// by tapping on it.
3535
///
3636
/// ## Example Usage
3737
///
@@ -41,8 +41,8 @@ class PusherBeams extends PusherBeamsPlatform with CallbackHandlerApi {
4141
/// }
4242
/// ```
4343
///
44-
/// In order to receive data you need to send the pusher message in the
45-
/// following format:
44+
/// In order to receive data the published payload must contain an [info] key
45+
/// in the [data] key:
4646
///
4747
/// ```json
4848
/// {

0 commit comments

Comments
 (0)