Configure the Communications Plugin

The off-the-shelf communications plugin comes with a default configuration. This configuration provides a default behavior, such as closing the frontend when making an outgoing call. This configuration is based on the configuration-framework and can be changed if necessary. This guide explains how to make such changes.

For a code example, see the examples/communications/configuration directory.

Communications plugin default configuration

The communications plugin default configuration is defined as a resource file that contains configuration keys and their values. The following keys and values are defined in the communications plugin:

1<resources>
2    <!-- Indicates that the communications panel will be kept open when starting an outgoing call. By default it is set to false. -->
3    <bool name="keepCommunicationsPanelOpenOnOutgoingCallConfigKey">false</bool>
4    <!-- Indicates that the task process panel will not be instantiated for an ongoing call. By default it is set to false. -->
5    <bool name="suppressCallTaskProcessPanelConfigKey">false</bool>
6</resources>

Changing the communications plugin configuration

The communications plugin default configuration can be changed by adding a custom configuration resource file in your application, such as src/main/res/values/example-communication-configuration.xml, which then overrides the default values with the ones provided.

Configuring the frontend's behavior when making an outgoing call

When an outgoing call is made, the communications frontend will be closed by default.

If you don't want to close the frontend provided with the off-the-shelf communications plugin, you can configure it by setting the keepCommunicationsPanelOpenOnOutgoingCallConfigKey to true:

src/main/res/values/example-communication-configuration.xml

<bool name="keepCommunicationsPanelOpenOnOutgoingCallConfigKey">true</bool>

Suppressing the task process panel for an ongoing call

By default, for an ongoing call the communications frontend shows a task process panel with the call information.

If you don't want this task process panel to show, you can configure it by setting the suppressCallTaskProcessPanelConfigKey to true:

src/main/res/values/example-communication-configuration.xml

<bool name="suppressCallTaskProcessPanelConfigKey">true</bool>