Event: "messages:offline:start"

In the following cases a very small amount of offline messages may be received:

  • After a successful sign in
  • After coming back online from being away

This begins with the event messages:offline:start and ends with the event messages:offline:stop.

Properties

PropertyTypeDescription
replayMessageCountnumberThe total number of messages which will be replayed between messages:offline:start and messages:offline:stop

Examples

client.on('messages:offline:start', function (event) {
  console.log(
    'will receive',
    event.replayMessageCount,
    'messages'
  );
});