Interface RtmConfig

Interface holding the configuration of an RtmClient instance.

You can pass it as the second argument when calling the createInstance method, or use it when calling the updateConfig method.

Hierarchy

  • RtmConfig

Properties

enableCloudProxy? enableLogUpload? logFilter?

Properties

Optional enableCloudProxy

enableCloudProxy?: boolean

Whether to enable cloud proxy.

Optional enableLogUpload

enableLogUpload?: boolean

Whether to enable log upload. It is set to false by default.

  • true: Enable log upload,
  • false: (Default) Disable log upload.

Optional logFilter

logFilter?: LogFilterType

Output log level of the SDK.

You can use one or a combination of the filters. The log level follows the sequence of OFF, ERROR, WARNING, and INFO. Choose a level to see the logs preceding that level. If, for example, you set the log level to WARNING, you see the logs within levels ERROR and WARNING.

  • AgoraRTM.LOG_FILTER_OFF
  • AgoraRTM.LOG_FILTER_ERROR
  • AgoraRTM.LOG_FILTER_INFO (Default)
  • AgoraRTM.LOG_FILTER_WARNING

Settings

Member Visibility

Theme

Generated using TypeDoc