Controller: /nodeworx/notice¶
- Required Permissions
LOGIN
Action: dismissBanner
¶
- Added in Version
4.7.0-339
- Description
Dismisses a banner notice.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
* indicates that it’s actually required, but probably already has a valid default value.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: ignoreUntil
¶
- Added in Version
4.7.0-339
- Description
Ignore a notice until a certain time.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (integer) |
Yes |
|||
|
integer |
Yes |
0, 1, 2, 3, 4, 5 |
Action: listBannerNotices
¶
- Added in Version
4.7.0-339
- Description
Lists current banner notices.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'delivery_id' => '1',
'code' => '',
'priority' => 'positive',
'node_id' => '',
'subject' => '##LG_WELCOMETONODEWORX##',
'body' => '##LG_GOIWORX_WELCOME##',
'date_created' => '1578808273',
),
1 =>
array (
'delivery_id' => '2',
'code' => 'SWAP_USAGE',
'priority' => 'negative',
'node_id' => '',
'subject' => 'Warning: Swap File Usage',
'body' => '##LG_PROBLEM_LOW_SWAP_MESSAGE##',
'date_created' => '1578808273',
),
),
'reply_code' => 205,
)
Action: removeUnsubscription
¶
- Added in Version
4.7.0-339
- Description
Removes an unsubscription block for the current user.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, … |
Action: unsubscribe
¶
- Added in Version
4.7.0-339
- Description
Unsubscribes the current user from a problem code.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Action: unsubscribeAll
¶
- Added in Version
6.1.9-1465
- Description
Unsubscribe from all notices.
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.