Newer Version Available

This content describes an older version of this product. View Latest

removeMessageHandler()

Unmounts the message-handling function.

Sample

When using React, it’s necessary to unmount functions to remove them from the DOM and perform necessary cleanup.

Used within a JavaScript app uploaded as a static resource and referenced by lightning:container, this example unmounts a message handling function.
1componentWillUnmount() {
2  LCC.removeMessageHandler(this.onMessage);
3}

You can view and download this example in the Developerforce Github Repository.

Arguments

Name Type Description
handler: (userMsg: any) => void function The function that handles messages sent from the Aura component.

Response

None.