onConnect

abstract suspend fun onConnect()

Handles the connection process of a data source.

Use this method to perform operations that initiate a connection and start the flow of data from an underlying data source. For instance, operations like connecting a websocket, opening a source file, or starting a polling timer are all operations that may be performed in this method.

This method is called by the ArcGIS Maps SDK when the connection is required. This can be due to an explicit call to CustomDynamicEntityDataSource.connect or called implicitly when a layer that contains the data source needs to be rendered.

If the connect operation fails, an exception should be thrown. The exception is passed back to the data source and is available as a connection error on DynamicEntityDataSource.connectionStatus.

Since

200.2.0

Throws

if an initial connection cannot be established