Skip to main content

interface

AudioDriver​

Interface for implementing an audio driver on the platform.
Methods
fun setReader(reader: AudioStreamReader): Unit
Sets the callback function that the audio driver calls to load data.<p>Calling this method repeatedly overwrites the previously saved callback function.</p>
Parameters
reader
Returns
fun setAvailableCallback(callback: AvailableCallback): Unit
Parameters
callback
Returns
fun available(): Boolean
Whether the audio device is currently available to the application.
Returns
fun play(): Unit
Launches the playing of the sound stream.<p>Once this method is called, a callback function must be called if it is set in the set_reader method.</p><p>If the callback function returns 0 written bytes, the playing of the sound stream can be stopped.</p>
Returns

BufferedChannel​

Extends: ru.dgis.sdk.Channel
Properties
val value
T?

CameraMoveController​

Class that allows you to control the position of the camera for the needs of animation.<p>The class must be thread-safe.</p>
Methods
fun position(time: Duration): CameraPosition
Position of the viewing area at a particular point in time. The controller must be prepared for the animation times to be passed in any order, not necessarily non-decreasing.
Parameters
time
Time from the start of the animation in milliseconds.
Returns
CameraPositionPosition of the viewing area at the specified point in time.
fun animationTime(): Duration
Animation duration in milliseconds.
Returns
DurationAnimation duration in milliseconds.

Channel​

Methods
@CheckResult
fun connect(executor: Executor, callback: ChannelCallback<T>): AutoCloseable
Parameters
executor
callback
Returns
@CheckResult
fun connect(callback: ChannelCallback<T>): AutoCloseable
Parameters
callback
Returns

CustomFollowController​

Interface that can be implemented on the platform to create custom controller for parameter tracking. To add a controller to a camera, you need to implement this interface and create a FollowController object passing an object that implements this interface as an argument.
Methods
fun availableValues(): EnumSet<FollowValue>
Set of value types that this controller can manage.
Returns
fun requestValues(values: EnumSet<FollowValue>): Unit
Tells the controller which values it provides are in use. This frees up the resources associated with calculating unused values. The method can be called multiple times with different values, in which case the last one is considered relevant.
Parameters
values
Returns
fun setNewValuesNotifier(notifier: NewValuesNotifier?): Unit
Installs a notifier that notifies about new values. The notifier must be stored in the implemented controller
Parameters
notifier
Returns
fun coordinates(): GeoPoint?
Geographical coordinates.
Returns
fun bearing(): Bearing?
Bearing. Method is called only after calling request_values with appropriate parameters.
Returns
fun tilt(): Tilt?
Map tilt.
Returns
fun styleZoom(): StyleZoom?
Map style zoom level.
Returns

Future​

Extends: java.lang.AutoCloseable
Methods
fun onComplete(
	executor: Executor,
	resultCallback: FutureResultCallback<T>,
	errorCallback: FutureErrorCallback
): Unit
Parameters
executor
resultCallback
errorCallback
Returns
fun onComplete(resultCallback: FutureResultCallback<T>, errorCallback: FutureErrorCallback): Unit
Parameters
resultCallback
errorCallback
Returns
fun onResult(executor: Executor, callback: FutureResultCallback<T>): Unit
Parameters
executor
callback
Returns
fun onResult(callback: FutureResultCallback<T>): Unit
Parameters
callback
Returns
fun onError(executor: Executor, callback: FutureErrorCallback): Unit
Parameters
executor
callback
Returns
fun onError(callback: FutureErrorCallback): Unit
Parameters
callback
Returns
suspend fun await(): T
Returns
T

HttpClient​

Interface for implementing a network client on a platform.
Methods
fun sendRequest(request: HttpRequest, callback: HttpResponseCallback): Unit
Method for handling requests from SDK.
Parameters
request
Request to be sent.
callback
Object with callbacks for sending and receiving data.
Returns

LocationChangeListener​

Interface for reporting changes in geolocation and its availability.
Methods
fun onLocationChanged(locations: Array<Location>): Unit
Parameters
locations
Returns
fun onAvailabilityChanged(availability: Boolean): Unit
Parameters
availability
Returns

LocationService​

Interface providing the last known geolocation.
Properties
val lastLocation
Currently best known geolocation. If there is no currently known geolocation, null is returned. The returned geolocation may be unreliable, such as being out of date and/or not meeting the required accuracy.

LocationSource​

Methods
fun activate(listener: LocationChangeListener): Unit
Parameters
listener
Returns
fun deactivate(): Unit
Returns
fun setDesiredAccuracy(accuracy: DesiredAccuracy): Unit
Parameters
accuracy
Returns

LogSink​

Log sink.
Methods
fun write(message: LogMessage): Unit
Writes to log. Can be called from any thread.
Parameters
message
Returns

MagneticHeadingSource​

Methods
fun activate(listener: MagneticChangeListener): Unit
Parameters
listener
Returns
fun deactivate(): Unit
Returns

MapEventSender​

Interface that allows you to send an input event to the map.
Methods
fun sendEvent(event: Event): Unit
Parameters
event
Returns

MapGestureRecognitionEngine​

Interface for gesture recognition.
Extends: java.lang.AutoCloseable
Methods
fun processMotionEvent(event: MotionEvent): Boolean
Parameters
event
Returns
fun resetRecognitionState(): Unit
Returns
fun onDevicePpiChanged(devicePpi: DevicePpi): Unit
Parameters
devicePpi
Returns
fun setMapEventSender(mapEventSender: MapEventSender): Unit
Parameters
mapEventSender
Returns

MutableChannel​

Extends: ru.dgis.sdk.Channel
Methods
fun send(value: T): Unit
Parameters
value
T
Returns

MutableStatefulChannel​

Extends: ru.dgis.sdk.StatefulChannel
Properties
var value
T

RadarApiHttpClient​

HTTP client interface for Radar API.
Methods
fun post(
	url: String,
	body: String,
	headers: Map
): RadarHttpResponse
Sends a POST request to the specified URL.
Parameters
url
Request URL.
body
Request body in JSON format.
headers
Returns
RadarHttpResponseServer response in the form of RadarHttpResponse.

RoadEventActionButtonModel​

Action button model for a traffic event.
Methods
fun onClicked(): Unit
Action on click.
Returns
Properties
val icon
Icon?
Icon.
val name
Name, for example, "Confirm".
val countChannel
Number of actions applied to the event by all users.
val highlightChannel
Highlight.

SafeLocationListener​

Extends: android.location.LocationListener
Methods
fun onProviderDisabled(provider: String): Unit
Parameters
provider
Returns
fun onProviderEnabled(provider: String): Unit
Parameters
provider
Returns
fun onStatusChanged(
	provider: String,
	status: Int,
	extras: Bundle
): Unit
Parameters
provider
status
extras
Returns

SearchViewCallback​

Interface for setting callback functions for SearchLayout.
Methods
fun directoryObjectChosen(obj: DirectoryObject): Unit
Method will be called when the user selects a result from the search results. The selected DirectoryObject will be returned.
Parameters
obj
Returns
fun searchCompletedSuccessfully(items: List<DirectoryObject>): Unit
Method will be called when the search is successful. A list of DirectoryObject results obtained from the search results will be returned.
Parameters
items
Returns
fun searchCompletedWithException(message: String): Unit
Method will be called if an exception occurs during the search. The message from the exception will be returned.
Parameters
message
Returns
fun searchAborted(): Unit
Method will be called if the search string has been cleared of input.
Returns
fun searchClosed(): Unit
Method will be called if the user closed the search in the standard way: with the close button next to the search bar.
Returns

SearchViewConfigurator​

Interface for setting up search in SearchLayout.
Methods
fun setSuggestorType(suggestorType: SuggestorType): Unit
Sets the type of the suggester. Default: SuggestorType.GENERAL
Parameters
suggestorType
Returns
fun setSortingType(sortingType: SortingType): Unit
Sets the type of the search results. Default: SortingType.BY_RELEVANCE
Parameters
sortingType
Returns
fun setAllowedSearchResultTypes(allowedSearchResultTypes: List<ObjectType>): Unit
Sets the object types of ObjectType allowed in the search query result. Default: all except ObjectType.ROUTE
Parameters
allowedSearchResultTypes
Returns
fun setAllowedSuggestedTypes(allowedSuggestedTypes: List<SuggestedType>): Unit
Sets the object types of SuggestedType allowed in the suggests. Default: all except SuggestedType.ROUTE.
Parameters
allowedSuggestedTypes
Returns
fun setPageSize(size: Int): Unit
Sets limit on the number of hints in suggest and of search results. Valid values ​​range from 1 to 50. Default: 10.
Parameters
size
Returns
fun setSpatialRestrictions(spatialRestriction: List?<GeoPoint>): Unit
Set the search area limit in the form of a polygon. The first and the last points of the polygon do not have to match Default: missing.
Parameters
spatialRestriction
Returns
fun setAreaOfInterest(rect: GeoRect?): Unit
Sets a rectangular area of interest in geographic coordinates. Default: missing.
Parameters
rect
Returns
fun setSearchType(type: SearchType): Unit
Sets the SearchType type of the search engine. Possible options and default values ​​depend on the SDK delivery type. See SearchType and SearchOptions for details.
Parameters
type
Returns
fun setLocationProvider(provider: LocationService?): Unit
Sets a geolocation provider to determine the distance to an object in the search results. Not set by default.
Parameters
provider
Returns

SimpleClusterRenderer​

Class for customizing cluster appearance in IMapObjectManager.
Methods
fun renderCluster(cluster: SimpleClusterObject): SimpleClusterOptions
Gets a marker for the cluster.
Parameters
cluster
Cluster object.
Returns
SimpleClusterOptionsCluster marker object.

SpeechRecognizer​

Methods
fun recognize(onResult: Function1, onError: Function1): Unit
Runs speech recognition and handles the results via callback functions.
Parameters
onResult
Callback function to get the recognized text as a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/">String</a>. Called when speech recognition is successful.
onError
Callback function to get an <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-exception/">Exception</a> when a recognition error occurs. Called to process various errors during the recognition process.
Returns

StatefulChannel​

Extends: ru.dgis.sdk.Channel
Properties
val value
T

StyleZoomToTiltRelation​

Object for describing the dependence of the camera tilt angle on the style zoom level.
Methods
fun styleZoomToTilt(styleZoom: StyleZoom): Tilt
Gets camera tilt based on style zoom level.
Parameters
styleZoom
Style zoom.
Returns
TiltCamera tilt angle <p>The function should be continuous and monotonic.</p> <p>The function should be thread-safe.</p>

TouchEventsObserver​

Methods
fun onTap(point: ScreenPoint): Unit
Parameters
point
Returns
fun onLongTouch(point: ScreenPoint): Unit
Parameters
point
Returns
fun onDragBegin(data: DragBeginData): Unit
Parameters
data
Returns
fun onDragMove(point: ScreenPoint): Unit
Parameters
point
Returns
fun onDragEnd(): Unit
Returns