Notifications

getAvailability([, propertyNames])

Declaration

hmkit.commands.Notifications.getAvailability()

Parameters

propertyNames

(optional) Array of names of the properties you want returned.

Example

// Get availability for all properties
hmkit.telematics.sendCommand(
  hmkit.commands.Notifications.getAvailability(),
  accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
  hmkit.commands.Notifications.getAvailability(['text']),
  accessCertificate
);

Response

Parameters

availability(Object)
updateRate.value

(String) enum

rateLimit.value

(Number)

rateLimit.unit

(String)

appliesPer.value

(String)

Discussion

The response contains an availability object for each property, as shown in the example

Example

{
  "text": {
    "availability": {
      "updateRate": {
        "value": "trip_high"
      },
      "rateLimit": {
        "value": 64,
        "unit": "hertz"
      },
      "appliesPer": {
        "value": "vehicle"
      }
    }
  }
}

notification({ text, actionItems })

Parameters

text

(String) Text for the notification

actionItems

(Array)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Notifications.notification({
    "text": "Open Garage",
    "actionItems": [
      {
        "id": {
          "value": 27
        },
        "name": {
          "value": "Open"
        }
      },
      {
        "id": {
          "value": 28
        },
        "name": {
          "value": "Cancel"
        }
      }
    ]
  }),
  accessCertificate
);

action({ activatedAction })

Parameters

activatedAction

(Number) (uinteger) Identifier of the activated action

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Notifications.action({
    "activatedAction": 27
  }),
  accessCertificate
);

clearNotification()

Parameters

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Notifications.clearNotification({}),
  accessCertificate
);