Note

You are viewing the documentation for an older release of Interworx (8.0). To see documentation for the current generally available release of Interworx, click here: 8.2.

Controller: /siteworx/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
delivery_id	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
delivery_id	struct (integer)	Yes
ignore_until	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' => 4,
      'code' => '',
      'priority' => 'negative',
      'node_id' => '',
      'subject' => 'Test notice',
      'body' => 'Test Notice!',
      '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
code	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
controller	string	Yes	Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

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
code	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.