allowedProcedures Field

The open and wakeup messages contain the allowedProcedures field, which contains a list of procedures that the plug-in is allowed to send before it's closed. With this list, a plug-in may check the procedures that are available for the current device without calling them. This helps the plug-in disable its functions and/or user interface elements that depend on some procedures (for example, scanBarcode, which is available only in Oracle Field Service Mobile native app).

Only updateIconData and updateButtonsIconData are available when plug-ins work in the background. To consider a procedure as available, the plug-in must assure that the key for a field in allowedProcedures corresponds to the name of the procedure and its value is true.

Example of open message with allowedProcedures

{
    "apiVersion": 1,
    "method": "open",
    "entity": "activityList",
    "activityList": {
        "4224031": {
            "aworktype": "4",
            "astatus": "pending",
            "aid": "4224031"
        },
    },
    "buttonId": "20361",
    "openParams": {},
    "allowedProcedures": {
        "openLink": true,
        "searchParts": true,
        "searchPartsContinue": true,
        "getParts": true,
        "getPartsCatalogsStructure": true,
        "updateIconData": true,
        "updateButtonsIconData": true,
        "scanBarcode": true
    }
}

Example of wakeup message with allowedProcedures

{
    "apiVersion": 1,
    "method": "wakeup",
    "event": "timer",
    "allowedProcedures": {
        "updateIconData": true,
        "updateButtonsIconData": true
    }
}