Webportal v2

embedded apps

API Reference - HMI.infotip

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

This API allows to interact with the HMI infoTip element.

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

Text of the info tip.

string

n/a

 		This is an InfoTipGroup with multiple lines of text because sometimes we need to have more explanation. true
Output Data
Data name Description Type Unit/Values Example
dialogId

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

int

n/a

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

webportal.set(
    /* api name */
    "HMI.infotip",
    /* parameters */
    "This is an InfoTipGroup with multiple
lines of text because sometimes we
need to have more explanation."
  )
  /* 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

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SET", 
  "api": "HMI.infotip",
  "params": "This is an InfoTipGroup with multiple
lines of text because sometimes we
need to have more explanation."
}

1
2
3
4
5
6
7
8
9
10

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

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

false

SUBSCRIBE
HMI.infotip
Edit

This API allows to interact with the HMI infoTip element.

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

ID of the infoTip being triggered. This ID is also returned in Set.

int

n/a

 		42
eventType

Dialog event related to the triggering of this infoTip.

Enum of strings

 - open
- close 		created
target

String

 dialog
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.infotip",
    /* 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.infotip",
  "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
16

// --- 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.infotip",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "dialogId": 42,
    "eventType": "created",
    "target": "dialog"
  } 
}

Back to Ref List

Related References