sendCustomMessage static method

Future<CustomMessage?> sendCustomMessage(
  1. CustomMessage message, {
  2. MessageSentListener? listener,
  3. dynamic onSuccess(
    1. CustomMessage message
    )?,
  4. dynamic onError(
    1. CometChatException excep
    )?,
})

send custom messages which are neither text nor media messages.

receiverId Unique id of the user or group to which the message is to be sent.

receiverType Type of the receiver i.e user or group

customType custom message type that you need to set.

customData The data to be passed as the message in the form of a JSONObject.

Migration Note: Migrated from platform channels to native Dart implementation. Behavior and signature remain identical for backward compatibility.

Android Reference: MessagesRequest.sendCustomMessage(CustomMessage message)

The method could throw PlatformException with error codes specifying the cause Offline (opt-in, additive): pass listener for the three-phase send. A listener-less send never enters the outbox — see _offlineAdoptingSend.

Implementation

static Future<CustomMessage?> sendCustomMessage(
  CustomMessage message, {
  MessageSentListener? listener,
  Function(CustomMessage message)? onSuccess,
  Function(CometChatException excep)? onError,
}) async {
  final offlineAcked = await _offlineAdoptingSend(message, listener);
  if (offlineAcked != null) return offlineAcked as CustomMessage?;
  try {
    // Get SDK instance
    final sdk = SdkRegistry.getInstance();

    // Call native Dart message repository
    final sentMessage = await sdk.messages.sendCustomMessage(message);

    // A7: an own threaded send auto-subscribes the sender (BEH-FLAG-08).
    // Queued, not awaited: the callback never waits on the cache.
    unawaited(OfflineRuntime.instance.onOwnDirectSendSucceeded(sentMessage));

    // Call success callback (listener wins — never both).
    if (listener != null) {
      listener.onMessageSent(sentMessage);
    } else if (onSuccess != null) {
      onSuccess(sentMessage);
    }
    return sentMessage;
  } on SdkException catch (sdkEx) {
    // Convert SdkException to CometChatException
    final cometChatEx = CometChatException(
      sdkEx.code,
      sdkEx.details ?? sdkEx.message,
      sdkEx.message,
    );
    if (listener != null) {
      listener.onError(cometChatEx);
    } else {
      _errorCallbackHandler(cometChatEx, null, null, onError);
    }
  } catch (e) {
    if (listener != null) {
      listener.onError(
        CometChatException('ERROR', e.toString(), e.toString()),
      );
    } else {
      _errorCallbackHandler(null, null, e, onError);
    }
  }
  return null;
}