API Documentation
Back to top  

InfoBoxServiceInterface

Extends

Interface InfoBoxServiceInterface

category

System
package

InfoBox
subpackage

Interfaces

Methods

Adds a new info box message.

addMessage(\InfoBoxMessage $message)

Arguments

$message

\InfoBoxMessage

Message to save.

Deletes a message by its ID.

deleteMessageById(\IdType $id)

Arguments

$id

\IdType

Message ID.

Deletes a message based on its identifier.

deleteMessageByIdentifier(\StringType $identifier)

Arguments

$identifier

\StringType

Message identifier.

Deletes a message based on the source.

deleteMessageBySource(\StringType $source)

Arguments

$source

\StringType

Message source.

Returns all info box messages.

getAllMessages() : \InfoBoxMessageCollection

Response

\InfoBoxMessageCollection

Reactivates the messages.

reactivateMessages()

Updates a message status.

setMessageStatus(\IdType $id, \StringType $status)

Arguments

$id

\IdType

Message ID.

$status

\StringType

Message status.