profi-sdk-aos-model/com.sygic.profi.model.fb.cmd/PFCommandRequest

PFCommandRequest

class PFCommandRequest : Table

Represents request of user speech to a command containing context for Profi Navi

Constructors

PFCommandRequest

fun PFCommandRequest()

Types

Companion

object Companion

Functions

__assign

fun __assign(_i: Int, _bb: ByteBuffer): PFCommandRequest

__init

fun __init(_i: Int, _bb: ByteBuffer)

__reset

open fun __reset()

argStrInByteBuffer

fun argStrInByteBuffer(_bb: ByteBuffer): ByteBuffer

argStrs

fun argStrs(j: Int): String?

Used to enrich action with several custom texts

calculateRoute

fun calculateRoute(obj: PFCalculateRoute): PFCalculateRoute?

correlationIdInByteBuffer

fun correlationIdInByteBuffer(_bb: ByteBuffer): ByteBuffer

getByteBuffer

open fun getByteBuffer(): ByteBuffer

itinerary

fun itinerary(obj: PFCmdItinerary): PFCmdItinerary?

locationInfo

fun locationInfo(obj: PFLocationInfo): PFLocationInfo?

mapMode

fun mapMode(obj: PFSetMapMode): PFSetMapMode?

mapUpdateRequest

fun mapUpdateRequest(obj: PFCmdMapUpdateRequest): PFCmdMapUpdateRequest?

navigationReportRequest

fun navigationReportRequest(obj: PFCmdNavigationReportRequest): PFCmdNavigationReportRequest?

position

fun position(obj: PFGeoPosition): PFGeoPosition?

positions

fun positions(j: Int): PFGeoPosition?

Used with action which provides array of positions

fun positions(obj: PFGeoPosition, j: Int): PFGeoPosition?

routeOptions

fun routeOptions(j: Int): PFSetRouteOption?

Route option to be set

fun routeOptions(obj: PFSetRouteOption, j: Int): PFSetRouteOption?

fun search(obj: PFSearch): PFSearch?

startGuidance

fun startGuidance(obj: PFStartGuidance): PFStartGuidance?

Properties

action

val action: Int

Defines action which the user wants to be triggered by Profi Navi

argBool

val argBool: Boolean

Used to enrich action with true/false paremeter

argStr

val argStr: String?

Used to enrich action with custom text, f.e. recognized address by speech recognition

argStrAsByteBuffer

val argStrAsByteBuffer: ByteBuffer

argStrsLength

val argStrsLength: Int

calculateRoute

val calculateRoute: PFCalculateRoute?

Used with action which starts route calculation

correlationId

val correlationId: String?

Defines attribute used for correlating messages within different asynchronous calls

correlationIdAsByteBuffer

val correlationIdAsByteBuffer: ByteBuffer

guidancePrompt

val guidancePrompt: Byte

Used with action which controls guidance prompt

itinerary

val itinerary: PFCmdItinerary?

Itinerary to be used

locationInfo

val locationInfo: PFLocationInfo?

Used with action which provides location info

mapCamera

val mapCamera: Byte

Used with action which controls map camera setting

mapMode

val mapMode: PFSetMapMode?

Used with action which sets map mode

mapUpdateRequest

val mapUpdateRequest: PFCmdMapUpdateRequest?

Request for map update

navigationReportRequest

val navigationReportRequest: PFCmdNavigationReportRequest?

request to send report about status of current route

position

val position: PFGeoPosition?

Used with action which provides position

positionsLength

val positionsLength: Int

routeOptionsLength

val routeOptionsLength: Int

val search: PFSearch?

Used with action which starts search

startGuidance

val startGuidance: PFStartGuidance?

Used with action which starts guidance