Replacing code blocks with tutorial placeholders

Author: darryncampbell-pubnub

flutter_sdk_tutorial/lib/providers/friendly_names.dart

@@ -33,15 +33,9 @@ class FriendlyNamesProvider with ChangeNotifier {
       //  We already have a name for this uuid
       return;
     }
-    GetUuidMetadataResult lookupResult;
-    try {
-      lookupResult = await pubnub.objects.getUUIDMetadata(uuid: deviceId);
-    } catch (e) {
-      //  Caught exception when looking up name
-      return;
-    }
-    GetUuidMetadataResult result = lookupResult;
-    groupMemberDeviceIds[deviceId] = result.metadata?.name;
+
+    //  TUTORIAL: STEP 2I CODE GOES HERE (1/2)
+
     notifyListeners();
   }
 

flutter_sdk_tutorial/lib/providers/messages.dart

@@ -23,51 +23,17 @@ class MessageProvider with ChangeNotifier {
     //  When the application is first loaded, it is common to load any recent chat messages so the user
     //  can get caught up with conversations they missed.  Every application will handle this differently
     //  but here we just load the 8 most recent messages
-    var result = pubnub.batch.fetchMessages({AppState.channelName}, count: 8);
-    result.then((batchHistoryResult) {
-      if (batchHistoryResult.channels[AppState.channelName] != null) {
-        List<BatchHistoryResultEntry> historyResults = batchHistoryResult
-            .channels[AppState.channelName] as List<BatchHistoryResultEntry>;
-        historyResults.forEach((element) async => {
-              _addMessage(ChatMessage(
-                  timetoken: '${element.timetoken}',
-                  channel: AppState.channelName,
-                  uuid: element.uuid.toString(),
-                  message: element.message)),
-
-              //  Look up the friendly names for any uuids found in the history
-              await AppState.friendlyNames
-                  .lookupMemberName(element.uuid.toString())
-            });
-      }
-    });
+
+    //  TUTORIAL: STEP 2G CODE GOES HERE
 
     //  Applications receive various types of information from PubNub through a 'listener'
     //  This application dynamically registers a listener when it comes to the foreground
-    subscription.messages.listen((m) {
-      if (m.messageType == MessageType.normal) {
-        //  A message is received from PubNub.  This is the entry point for all messages on all
-        //  channels or channel groups, though this application only uses a single channel.
-        _addMessage(ChatMessage(
-            timetoken: '${m.publishedAt}',
-            channel: m.channel,
-            uuid: m.uuid.value,
-            message: m.content));
-
-        //  Interactive Demo only
-        if (m.uuid.value != AppState.deviceId) {
-          DemoInterface.actionCompleted(
-              "Receive a message (You might need to open a new tab)");
-        }
-      } else if (m.messageType == MessageType.objects) {
-        //  Whenever Object meta data is changed, an Object event is received.
-        //  See: https://www.pubnub.com/docs/chat/sdks/users/setup
-        //  Use this to be notified when other users change their friendly names
-        AppState.friendlyNames.replaceMemberName(
-            m.payload['data']['id'].toString(),
-            m.payload['data']['name'].toString());
-      }
-    });
+
+    //  TUTORIAL: STEP 2D CODE GOES HERE (2/2)
+
+    //  TUTORIAL: STEP 2E CODE GOES WITHIN THE CODE COPIED ABOVE
+
+    //  TUTORIAL: STEP 2I CODE GOES WITHIN THE CODE COPIED ABOVE (2/2)
   }
   MessageProvider(PubNubInstance pn) : this._(pn.instance, pn.subscription);
 
@@ -80,7 +46,7 @@ class MessageProvider with ChangeNotifier {
   }
 
   sendMessage(String channel, String message) async {
-    await pubnub.publish(channel, message);
+    //  TUTORIAL: STEP 2C CODE GOES HERE
 
     //  Interactive Demo only
     DemoInterface.actionCompleted("Send a message");

flutter_sdk_tutorial/lib/providers/presence.dart

@@ -42,35 +42,10 @@ class PresenceProvider with ChangeNotifier {
     //  the channel.  This is similar to the earlier hereNow call but this API will only be
     //  invoked when presence information changes, meaning you do NOT have to call hereNow
     //  periodically.  More info: https://www.pubnub.com/docs/sdks/kotlin/api-reference/presence
-    chatSubscription.presence.listen((presenceEvent) {
-      switch (presenceEvent.action) {
-        case PresenceAction.join:
-          _addOnlineUser(presenceEvent.uuid!.value);
-          break;
-        case PresenceAction.leave:
-        case PresenceAction.timeout:
-          _removeOnlineUser(presenceEvent.uuid!.value);
-          break;
-        case PresenceAction.stateChange:
-          break;
-        case PresenceAction.interval:
-          //  'join' and 'leave' will work up to the ANNOUNCE_MAX setting (defaults to 20 users)
-          //  Over ANNOUNCE_MAX, an 'interval' message is sent.  More info: https://www.pubnub.com/docs/presence/presence-events#interval-mode
-          //  The below logic requires that 'Presence Deltas' be defined for the keyset, you can do this from the admin dashboard
-          if (presenceEvent.join.length > 0) {
-            _onlineUsers.addAll(presenceEvent.join.map((uuid) => uuid.value));
-          }
-          if (presenceEvent.join.length > 0) {
-            _onlineUsers.removeAll(presenceEvent.leave
-                .where((id) => id.value != AppState.deviceId)
-                .map((uuid) => uuid.value));
-          }
-          notifyListeners();
-          break;
-        default:
-          break;
-      }
-    });
+
+    //  TUTORIAL: STEP 2D CODE GOES HERE (1/2)
+
+    //  TUTORIAL: STEP 2F CODE GOES WITHIN THE CODE COPIED ABOVE (1/2)
   }
   PresenceProvider(PubNubInstance pn) : this._(pn.instance, pn.subscription);
 
@@ -84,10 +59,8 @@ class PresenceProvider with ChangeNotifier {
     //  The API will return an array of occupants in the channel, defined by their
     //  ID.  This application will need to look up the friendly name defined for
     //  each of these IDs (later)
-    var result = await pubnub.hereNow(channels: {AppState.channelName});
-    _onlineUsers.addAll(result.channels.values
-        .expand((c) => c.uuids.values)
-        .map((occupantInfo) => occupantInfo.uuid));
+
+    //  TUTORIAL: STEP 2F CODE GOES HERE (2/2)
 
     //  Resolve the friendly names of everyone found in the chat
     for (var element in _onlineUsers) {

flutter_sdk_tutorial/lib/screens/conversation.dart

@@ -95,19 +95,8 @@ class _ConversationState extends State<Conversation>
   //  Note that the Dart API uses slightly different terminology / behaviour to unsubscribe / re-subscribe.
   //  Note: This getting started application is set up to unsubscribe from all channels when the app goes into the background.
   //  This is good to show the principles of presence but you don't need to do this in a production app if it does not fit your use case.
-  @override
-  void didChangeAppLifecycleState(AppLifecycleState state) {
-    if (state == AppLifecycleState.paused) {
-      //  Mobile only: App has gone to the background
-      messageProvider.pubnub.announceLeave(channels: {AppState.channelName});
-      messageProvider.subscription.pause();
-    } else if (state == AppLifecycleState.resumed) {
-      //  Mobile only: App has returned to the foreground
-      messageProvider.subscription.resume();
-      messageProvider.pubnub
-          .announceHeartbeat(channels: {AppState.channelName});
-    }
-  }
+
+  //  TUTORIAL: STEP 2B CODE GOES HERE (2/2)
 
   @override
   void dispose() {

flutter_sdk_tutorial/lib/utils/pubnub_instance.dart

@@ -11,16 +11,13 @@ class PubNubInstance {
 
   PubNubInstance() {
     //  Create PubNub configuration and instantiate the PubNub object, used to communicate with PubNub
-    _pubnub = PubNub(
-        defaultKeyset: Keyset(
-            subscribeKey: AppState.pubnubSubscribeKey,
-            publishKey: AppState.pubnubPublishKey,
-            userId: UserId(AppState.deviceId!)));
+
+    //  TUTORIAL: STEP 2A CODE GOES HERE
 
     //  Subscribe to the pre-defined channel representing this chat group.  This will allow us to receive messages
     //  and presence events for the channel (what other users are in the room)
-    _subscription =
-        _pubnub.subscribe(channels: {AppState.channelName}, withPresence: true);
+
+    //  TUTORIAL: STEP 2B CODE GOES HERE (1/2)
 
     //  In order to receive object UUID events (in the addListener) it is required to set our
     //  membership using the Object API.

flutter_sdk_tutorial/lib/widgets/friendly_name.dart

@@ -72,9 +72,8 @@ class _FriendlyNameWidget extends State<FriendlyNameWidget> {
       //  Save the contents to PubNub object storage
       if (_controller.text.isNotEmpty) {
         setState(() => {_saveButtonText = "Edit", _enabled = false});
-        var uuidMetadataInput = UuidMetadataInput(name: _controller.text);
-        var result = await AppState.pubnub.instance.objects
-            .setUUIDMetadata(uuidMetadataInput, uuid: AppState.deviceId);
+
+        //  TUTORIAL: STEP 2H CODE GOES HERE
 
         //  Interactive Demo only
         DemoInterface.actionCompleted("Change your friendly name");