Custom menu schemas

Custom menu of a driver.

{  
    "rgmbut": [  
        mbut-1,  
        …,  
        mbut-N  
    ]  
}  

A widget that can appear on a custom menu.

{  

    "buta": buta,  
    "ptd": ptd,  
    "szd": szd,  
    "busty": busty,  
     "rgnotd": [notd1, …, notdN]  
}  

Describes the action performed and/or the data displayed by the widget.

{  
    "k": kbuta,  
    other-parameters  
 }  

Shows a button that triggers synchronization with the backend when pressed. Also displays the state of any ongoing synchronization and warns about any staleness of the data..

{  
    "k": "sync"  
}  

Shows a button that navigates to the list of trips assigned to the driver. Also displays the number of updated or new trips yet unread by the driver.

{  
    "k": "triplist"  
}  

Shows a button that navigates to the list of chat rooms the driver is a member of. Also displays the number of new messages in all chat rooms yet unread by the driver.

{  
    "k": "roomlist"  
}  

Shows a button that navigates to the list of documents uploaded to the driver’s file storage. Also displays the number of updated or new documents yet unread by the driver.

{  
    "k": "dbox"  
}      

Shows a button that allows the driver to scan and submit a new document. The document type can be configured via the kdocr field.

{  
    "k": "docr",  
    "kdocr": "gdam"  
}  

Shows a button that allows the driver to launch an external application on the device.

{  
    "k": "launchactivity",  
    "inspe": {  
        "oaction": "android.intent.action.MAIN",  
        "orgcat": ["android.intent.category.APP_CALCULATOR"]  
     }  
}  

Describes the Android Intent that is to be fired when the user presses a Launch External App button on the menu.

{  
    "oaction": intent-action,  
    "orgcat": [cat-1, …, cat-N],  
    "ocompn": component-name,  
    "odata": data-uri,  
    "omime": mime-type,  
    "ompextra": intent-extras  
}  

Specifies the exact target component to be executed by an intent. See also android: ComponentName.

{  
    "packagen": "com.example.sampletargetapp",  
    "classn": "com.example.sampletargetapp.TargetActivity"  
 }  

Specifies a list of named parameters to be passed to the target component.

{  
    "parameter-name-1": extra-value-1,  
    …,  
    "parameter-name-N": extra-value-N,  
 }  

Specifies a single parameter value along with its type. Can be one of the following.

A parameter of type byte.

{  
    "k": "byte",  
    "v": 255  
}  

A parameter of type short.

{  
    "k": "short",  
    "v": 128  
 }  

A parameter of type int.

{  
    "k": "int",  
    "v": 2147483647  
}  

A parameter of type long.

{  
    "k": "long",  
    "v": 9223372036854775807  
 }  

A parameter of type float.

{  
    "k": "float",  
    "v": 3.14  
}  

A parameter of type double.

{  
    "k": "double",  
    "v": 3.14   
}  

A parameter of type boolean.

{  
    "k": "boolean",  
    "v": true  
}  

A parameter of type string.

{  
    "k": "string",  
    "v": "Hello World!"  
}  

A parameter of type char.

{  

    "k": "char",  
    "v": "H"  
}  

A parameter of type array of bytes.

{  
    "k": "bytearray",  
    "v": [1, 2, …, 255]  
}  

A parameter of type array of shorts.

{  

    "k": "shortarray",  
    "v": [-127, -126, …, 128]  
}  

A parameter of type array of integers.

{  
    "k": "intarray",  
    "v": [-2147483648, …, 2147483647]  
}  

A parameter of type array of longs.

{  
    "k": "longarray",  
    "v": [-9223372036854775808, …, 9223372036854775807]  
}  

A parameter of type array of floats.

{  
    "k": "floatarray",  
    "v": [-3.14, …, 3.14]  
}  

A parameter of type array of doubles.

{  
    "k": "doublearray",  
    "v": [-3.14, …, 3.14]  
}  

A parameter of type array of booleans.

{  

    "k": "booleanarray",  
    "v": [false, true, …, true]  
}  

A parameter of type array of strings.

{  
    "k": "stringarray",  
    "v": ["Hello", "World", "!"]  
}  

A parameter of type array of chars.

{  
    "k": "chararray",  
    "v": ["H", "e", "l", …, "!"]  
}  

A parameter of type arraylist of integers.

{  
    "k": "integerarraylist",  
    "v": [-2147483648, …, 2147483647]  
}  

A parameter of type arraylist of strings.

{  
    "k": "stringarraylist",  
    "v": ["Hello", "World", "!"]  
}  

A parameter of type string containing arbitrary json-formatted data.

{  

    "k": "json",  
    "v": {  
        "Hello": "World"  
    }  
}  

The above sample is a syntax sugar for the following

{  

    "k": "string",  
    "v": "{\"Hello\":\"World\"}"  
 }  

Specifies position of the top-left corner of the widget on the screen.

{  
    "x": 4,  
    "y": 7.5  
}  

Widgets are laid out on the screen using a density-independent coordinate system.

The x axis of the coordinate system is divided into 9 equi-distant units. This axis always corresponds to the shorter edge of the screen, hence it is horizontal in portrait orientation and vertical in landscape orientation.

The y axis of the coordinate system is divided into 16 equi-distant units. This axis always corresponds to the longer edge of the screen, hence it is vertical in portrait orientation and horizontal in landscape orientation.

When changing orientation, the coordinate system is mirrored around the x=y line, or in other words it is mirrored along the vertical axis and then rotated by 90 degrees counterclockwise.

The (x: 0, y: 0) coordinate points to the top-left corner of the screen, whereas the (x: 9, y: 16) coordinate points to the bottom-right corner of the screen. The coordinate system maintains aspect ratio and thus a rectangle of (dx: 1, dy: 1) represents a square on the screen.

In portrait orientation (x: 9, y: 0) points to the top-right corner of the screen whereas in landscape orientation it points to the bottom-left corner of the screen. Similarly, (x: 0, y: 16) points to the bottom-left corner of the screen in portrait orientation and points to the top-right corner of the screen in landscape orientation.

Specifies size of the widget on the screen.

{  

    "dx": 4,  
    "dy": 7.5  
}  

Specifies visual appearance of the widget.

{
    "ost18Text": {
        "_": "Messages",
        "hu": "Üzenetek",
        "de": "Mitteilungen",
        "it": "Messaggi",
    },
    "okico": "Material.Filled.Messages",
    "ocolBg": "20d0d0d0",
    "ocolFg": "ffd0d0d0",
    "okrund": {
        "k": "relative",
        "percent": "50",
    }
}

Specifies an internationalized text.

{  
    "_": "Messages",  
    "locale-1": "Üzenetek",  
    "locale-2": "Mitteilungen",  
    …,  
    "locale-N": "Messaggi",  
}  

 or  

 "Messages"  

If multiple translations are provided, the app will choose the translation that corresponds to the preferred language set by the driver on the mobile device. If multiple languages match the preferred languages, the driver’s most preferred locale will be picked. If no translations match the driver's preferred language, the translation in the default locale will be picked. The translation in the default locale is required.

If internationalization is not necessary, it is also possible to provide the translation in the default locale using the following shorthand syntax:

{  
    "ost18Text": "Messages",  
    …  
}  

The above syntax is equivalent with the following expanded form

{  
    "ost18Text": {  
        "_": "Messages"  
    },  
    …  
}  

Specifies an icon from the Google Material Icons library.

"Library.Style.Icon"  

Specifies a color and transparency using the IEC 61966-2.1:1999 SRGB color space.

"AARRGGBB"  

Specifies the corner radius of a widget.

    {"k": "fixed", "dp": 4.5}

    // or 

    {"k": "relative", "percent": 50} 

    // or 

    {"k": "unit", "u": 0.1}  

Defines a customizable notification and/or badge to be shown to the user of the app when the screen is updated on the mobile device.

A notification is shown with the text defined in the ost18Message field, if the field is present. A badge is displayed on the button with the number specified in the ocBadge field, if the field is present. If another notification/badge having the same notid value is already being displayed, their text/value is updated by this notification.

Pressing the button or the notification will perform the usual action as defined in the buta field of the mbut structure and discard the notification/badge. Once the user marked a notification/badge as read, future notifications with the same notid will not be displayed.

{  

    "notid": "2023/03/23",  
    "ost18Message": {  
        "_": "You have received new data",  
        "hu": "Önnek új adata érkezett."  
    },  

    "ocBadge": 1  
}