/AWS1/CL_QSTVISUALMESSAGECONF¶
The configuration for a customizable message displayed on a visual. Supports parameter substitution in text fields.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_enabled TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN¶
Specifies whether the custom message is displayed on the visual. When set to
true, the custom message appears in place of the default message. When set tofalseor omitted, the default message is displayed.
iv_title TYPE /AWS1/QSTVISUALMESSAGETEXT /AWS1/QSTVISUALMESSAGETEXT¶
The title text of the message that is displayed on the visual.
iv_titlevisibility TYPE /AWS1/QSTVISIBILITY /AWS1/QSTVISIBILITY¶
Specifies whether the title of the message is displayed.
iv_description TYPE /AWS1/QSTVISUALMESSAGETEXT /AWS1/QSTVISUALMESSAGETEXT¶
The description text of the message that is displayed on the visual.
iv_descriptionvisibility TYPE /AWS1/QSTVISIBILITY /AWS1/QSTVISIBILITY¶
Specifies whether the description of the message is displayed.
iv_linktext TYPE /AWS1/QSTVISUALMESSAGETEXT /AWS1/QSTVISUALMESSAGETEXT¶
The display text of the hyperlink that is shown in the message.
iv_linkurl TYPE /AWS1/QSTVISUALMESSAGELINKURL /AWS1/QSTVISUALMESSAGELINKURL¶
The destination URL of the hyperlink that is shown in the message. Only valid
http,https, andmailtoURLs are supported.
iv_linkvisibility TYPE /AWS1/QSTVISIBILITY /AWS1/QSTVISIBILITY¶
Specifies whether the hyperlink in the message is displayed.
Queryable Attributes¶
Enabled¶
Specifies whether the custom message is displayed on the visual. When set to
true, the custom message appears in place of the default message. When set tofalseor omitted, the default message is displayed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLED() |
Getter for ENABLED |
Title¶
The title text of the message that is displayed on the visual.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
TitleVisibility¶
Specifies whether the title of the message is displayed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLEVISIBILITY() |
Getter for TITLEVISIBILITY, with configurable default |
ASK_TITLEVISIBILITY() |
Getter for TITLEVISIBILITY w/ exceptions if field has no val |
HAS_TITLEVISIBILITY() |
Determine if TITLEVISIBILITY has a value |
Description¶
The description text of the message that is displayed on the visual.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
DescriptionVisibility¶
Specifies whether the description of the message is displayed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTIONVISIBILITY() |
Getter for DESCRIPTIONVISIBILITY, with configurable default |
ASK_DESCRIPTIONVISIBILITY() |
Getter for DESCRIPTIONVISIBILITY w/ exceptions if field has |
HAS_DESCRIPTIONVISIBILITY() |
Determine if DESCRIPTIONVISIBILITY has a value |
LinkText¶
The display text of the hyperlink that is shown in the message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LINKTEXT() |
Getter for LINKTEXT, with configurable default |
ASK_LINKTEXT() |
Getter for LINKTEXT w/ exceptions if field has no value |
HAS_LINKTEXT() |
Determine if LINKTEXT has a value |
LinkUrl¶
The destination URL of the hyperlink that is shown in the message. Only valid
http,https, andmailtoURLs are supported.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LINKURL() |
Getter for LINKURL, with configurable default |
ASK_LINKURL() |
Getter for LINKURL w/ exceptions if field has no value |
HAS_LINKURL() |
Determine if LINKURL has a value |
LinkVisibility¶
Specifies whether the hyperlink in the message is displayed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LINKVISIBILITY() |
Getter for LINKVISIBILITY, with configurable default |
ASK_LINKVISIBILITY() |
Getter for LINKVISIBILITY w/ exceptions if field has no valu |
HAS_LINKVISIBILITY() |
Determine if LINKVISIBILITY has a value |