Skip to content
Events Service

Overview

//trimblecloud-events/trimblecloud.events.service.consumer/Consumer

Consumer

interface Consumer

This is the Consumer interface that defines the contract for consuming events from the Events Service.

Functions

NameSummary
acknowledge[JVM]
abstract fun acknowledge(acknowledgmentId: String)
This method is used to acknowledge an event.
close[JVM]
abstract fun close()
This method is used to close the consumer, once the events are consumed.
getResponseQueueSize[JVM]
abstract fun getResponseQueueSize(): Int
This method is used to get the size of the response queue.
getStatus[JVM]
abstract fun getStatus(): Status
Return the status of Events Service Consumer connection.
isActive[JVM]
abstract fun isActive(): Boolean
Return whether the Events Service Consumer connection is active.
poll[JVM]
abstract fun poll(request: ConsumerRequest)
This method is used to poll events.