publish method

Future<PublishResult> publish(
  1. String channel,
  2. dynamic message, {
  3. Keyset? keyset,
  4. String? using,
  5. Map<String, dynamic>? meta,
  6. bool? storeMessage,
  7. int? ttl,
  8. bool? fire,
  9. String? customMessageType,
})
inherited

Publishes message to a channel.

You can override the default account configuration on message saving using storeMessage flag - true to save and false to discard. Leave this option unset if you want to use the default.

You can set a per-message time to live in storage using ttl option. If set to 0, message won't expire. If unset, expiration will fall back to default.

meta parameter is for providing additional information with message that can be used for stream filtering.

To send message to PubNub BLOCKS EventHandler, set fire param value to true. Fire message is not replicated, and so will not be received by any subscribers to the channel. Fire message is also not stored in history.

If keyset is not provided, then it tries to obtain a keyset using name. If that fails, then it uses the default keyset. If that fails as well, then it will throw InvariantException.

Example:

var result = await pubnub.publish('my-ch', 'message');

Implementation

Future<PublishResult> publish(String channel, dynamic message,
    {Keyset? keyset,
    String? using,
    Map<String, dynamic>? meta,
    bool? storeMessage,
    int? ttl,
    bool? fire,
    String? customMessageType}) async {
  Ensure(channel).isNotEmpty('channel name');
  Ensure(message).isNotNull('message');

  keyset ??= keysets[using];
  Ensure(keyset.publishKey).isNotNull('publishKey');

  var payload = await super.parser.encode(message);

  if (keyset.cipherKey != null || crypto is CryptoModule) {
    payload = keyset.cipherKey == keysets.defaultKeyset.cipherKey
        ? await super
            .parser
            .encode(base64.encode(crypto.encrypt(utf8.encode(payload))))
        : await super.parser.encode(base64.encode(
            crypto.encryptWithKey(keyset.cipherKey!, utf8.encode(payload))));
  }

  var params = PublishParams(keyset, channel, payload,
      storeMessage: storeMessage,
      ttl: ttl,
      customMessageType: customMessageType);

  if (meta != null) {
    params.meta = await super.parser.encode(meta);
  }

  if (fire != null && fire) {
    params.storeMessage = false;
    params.noReplication = true;
  }

  _logger.verbose('Publishing a message to a channel $channel');

  return await defaultFlow<PublishParams, PublishResult>(
      keyset: keyset,
      core: this,
      params: params,
      serialize: (object, [_]) => PublishResult.fromJson(object));
}