cc-everywhere

Class: ChannelMessageListener

Implements

• IChannelMessengerDelegate

Constructors

Constructor

new ChannelMessageListener(
   sourceChannel, 
   targetProtocolVersion, 
   _filterRequestIdMismatch, 
   protocolHandlersModule?): ChannelMessageListener;

Parameters

Returns

ChannelMessageListener

Methods

reset()

reset(): void;

Returns

void

didGetMessage()

didGetMessage<T>(message, requestId?): void;

Type Parameters

Parameters

Returns

void

Implementation of

IChannelMessengerDelegate.didGetMessage

setTarget()

setTarget(targetChannel, targetChannelInfo): void;

Parameters

Returns

void

removeTarget()

removeTarget(targetChannel): void;

Parameters

Returns

void

hasTarget()

hasTarget(targetChannel): boolean;

Parameters

Returns

boolean

getTarget()

getTarget(targetChannel): 
  | TargetChannelInfo
  | undefined;

Parameters

Returns

| TargetChannelInfo | undefined

addListenerForTarget()

addListenerForTarget(targetChannel, callback): void;

Parameters

Returns

void

sendMessage()

sendMessage<T>(targetChannel, message): boolean;

Type Parameters

Parameters

Returns

boolean

sendMessageCompat()

sendMessageCompat<T>(targetChannel, message): boolean;

Sends a message using a message channel that is compatible with older version of SDK.

Type Parameters

Parameters

Returns

boolean

• True if the message was successfully sent, false otherwise.

addListener()

addListener(
   messageType, 
   listener, 
   messageFilter?): void;

Parameters

Returns

void

removeListener()

removeListener(messageType, listener): void;

Parameters

Returns

void

setRequestId()

setRequestId(requestId): void;

Parameters

Returns

void