Improve (provide literally any) documentation

[JayPerfetto]

Hi,

I really appreciate the work you've put into this package, but would it be possible to put some TLC into the documentation? Right now this package is nigh on impossible to implement unless you are an expert in cross-platform channel messaging and deeply complex package integration.

A mere example payload is not nearly sufficient in calling out the "magic" values that need to be passed, lest nothing work properly - additionally, there are no implementation steps, and the only way to understand how this package works is to try to read through the example and cherry pick the relevant bits of code.

Overall, the package is great but the developer experience using it is quite poor - please improve the documentation so that there is not such a massive list of questions in the Repo Issues that could easy have been addressed through proper docs.

Thanks!
Jason

[Chinmay-KB]

Hi,

I really appreciate the work you've put into this package, but would it be possible to put some TLC into the documentation? Right now this package is nigh on impossible to implement unless you are an expert in cross-platform channel messaging and deeply complex package integration.

A mere example payload is not nearly sufficient in calling out the "magic" values that need to be passed, lest nothing work properly - additionally, there are no implementation steps, and the only way to understand how this package works is to try to read through the example and cherry pick the relevant bits of code.

Overall, the package is great but the developer experience using it is quite poor - please improve the documentation so that there is not such a massive list of questions in the Repo Issues that could easy have been addressed through proper docs.

Thanks!
Jason

I second @JayPerfetto here. I had to drop this plugin altogether because I could not have a deep understanding of how to make it work according to my use case. Some documentation would be really nice for such a great plugin!

[cloudwebrtc]

@JayPerfetto @Chinmay-KB Hey, yes, I have realized the importance of documentation for developers. Currently, I am the only one who maintains flutter-webrtc community, and there is not much spare time, so the documentation has not been written in time. I will add documentation ASAP.

[efraespada]

@cloudwebrtc I'm working in a PR for providing some documentation to the community. If you agree of course.

#86

I've integrated Callkeep in my application and I think I have a clear idea about how it works 😄

[ahmedJD]

@efraespada the app crash when it's killed after display incomming call is there any solution?

[efraespada]

@ahmedJD you could be trying to use some methods (related with the permissions) that could need an activity which is not ready yet.

What I do in those cases is controlling the BuildContext for know if the application is completely terminated (context == null) or is ready (and can check the permissions with the activity).

Ensure you call the backToForeground method.

[ahmedJD]

@efraespada but the backToForeground is only working in android the crash appears in ios after display incomming call

[efraespada]

@ahmedJD I supposed it was happened in Android because I deal with this problem.

Have you any trace of the iOS error?

[ahmedJD]

@efraespada no the crash apperas when app is killed so i don't have any trace of the error in xcode :(

[efraespada]

@ahmedJD I'll do this:

• Ensure the required permissions are granted before start testing callkeep

• Comment/remove the callkeep usage in different point to notice where the crash is happening

• Try to show a notification for ensure the incoming call should appear (sometimes I didn't receive the FCM data)

PD: this is another issue. Open a new one or use an existing related one and mention me 😉

[ahmedJD]

@efraespada already did it #78