Webportal v2

embedded apps

API Reference - HMI.toast

Edit
Required Privacy: Data & Location
Operations:
SET
HMI.toast
Edit

This API allows to create and interact with the HMI Toast element.

webportal-v2-toast

Input Parameter
Param name Description Type Unit/Values Example Required
appId

ID of your App.

string

n/a

 		com.example.app true
title

Toast’s text content.

string

n/a

 		Your appointment with your favorite garage has been confirmed. true
Output Data
Data name Description Type Unit/Values Example
dialogId

ID of the toast you just set-up. This ID is also returned in Susbscribe.

int

n/a

 		42
dialogOpenError

Error code related to the toast.

int

 - 0: Dialog successfully openeded.
- 1: Failed, unspecified error happened.
- 2: Failed, invalid parameters were passed.
- 3: Failed, higher priority panel is currently shown on the screen.
- 4: Failed, discarded because incorrect specific conditions. 		0
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

webportal.set(
    /* api name */
    "HMI.toast",
    /* parameters */
     { 
      "appId": "com.example.app",
      "title": "Your appointment with your favorite garage has been confirmed."
        }
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })

1
2
3
4
5
6
7
8
9

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SET", 
  "api": "HMI.toast",
  "params":  { 
    "appId": "com.example.app",
    "title": "Your appointment with your favorite garage has been confirmed."
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "HMI.toast",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "dialogId": 42,
    "dialogOpenError": 0
  } 
}

false

SUBSCRIBE
HMI.toast
Edit

This API allows to create and interact with the HMI Toast element.

webportal-v2-toast

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
dialogId

ID of the toast being tiggered. This ID is also returned in Set.

int

n/a

 		42
eventType

Event related to the triggering of this toast.

Enum of strings

 - closeTimeout
- closeTouch 		closeTimeout
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

webportal.subscribe(
    /* api name */
    "HMI.toast",
    /* parameters */
     null,
    /* callback for `NOTIFY` messages */
    async (notifyMessage) => {
      if (notifyMessage.status === 200) {
        /* handle `NOTIFY` response */
      }
      else { /*  handle `NOTIFY` error  */ }
    }
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })

1
2
3
4
5
6

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SUBSCRIBE", 
  "api": "HMI.toast",
  "params":  null
}

1
2
3
4
5
6
7
8
9
10
11

// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "status": 200,
  "statusText": "OK"
}


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "NOTIFY",
  "api": "HMI.toast",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "dialogId": 42,
    "eventType": "closeTimeout"
  } 
}

Back to Ref List

Related References