Pass data from VoIP Notification down to RN

[rcidt]

This PR allows a developer to pass data received in the VoIP notification payload, down to the RN layer, when reporting a new incoming call.

[danjenkins]

Can you explain why this is useful? This should be handled by a notification library not by adding to callkeep

[rcidt]

@danjenkins We don't rely on SIP Registration to receive the INVITE.

The way we have implemented Inbound Calls, is by using a "rendezvous" type model. Meaning, the VoIP Notification, contains a telephone number, which we need to then use to make an outbound call, which will connect both ends.

This change allows us to pass that data down to the RN app as part of the didDisplayIncomingCall event parameters.

I notice now that this PR, as is, will be a breaking change. I will push a change to overload the method so that the payload parameter is optional.

[danjenkins]

But even so shouldn't it make its way into React Native using a notification library rather than shoehorning it into callkeep? Not saying this doesn't have merit, just being cautious about not adding things that should live elsewhere into the lib

[rcidt]

We made this change a while back, so my memory is not very clear as to details, but we experienced issues attempting to do just that. I believe that the behavior was inconsistent and we attributed it to Apple's overall crackdown on the way VoIP Notifications are used and handled.

PS. I just pushed a change that prevents this PR from breaking the current CallKeep API.

[manuquentin]

Thanks @rcidt, I'll update the index.ts file.