API Documentation
Back to top  

InfoBoxMessage

Implements \InfoBoxMessageInterface

Class InfoBoxMessage

category

System
package

InfoBox
subpackage

Entities

Methods

InfoBoxMessage constructor.

__construct()

Returns the message creation date time.

getAddedDateTime() : \DateTime

Response

\DateTime

The added date time.

Returns the message button label.

getButtonLabel(\LanguageCode $languageCode) : string

Arguments

$languageCode

\LanguageCode

Button label language code.

Response

string

The message button label.

Returns the button label collection.

getButtonLabelCollection() : \EditableKeyValueCollection

Response

\EditableKeyValueCollection

Returns the link of the message button.

getButtonLink() : string

Response

string

Link of the message button.

Returns the customer ID of the message.

getCustomerId() : integer

Response

integer

Returns the message headline.

getHeadLine(\LanguageCode $languageCode) : string

Arguments

$languageCode

\LanguageCode

Language code of the message headline.

Response

string

The message headline.

Returns the headline collection.

getHeadLineCollection() : \EditableKeyValueCollection

Response

\EditableKeyValueCollection

Returns the ID of the message.

getId() : integer

Response

integer

ID of the message.

Returns the message identifier.

getIdentifier() : string

Response

string

Message identifier.

Returns the message.

getMessage(\LanguageCode $languageCode) : string

Arguments

$languageCode

\LanguageCode

Language code of the message.

Response

string

The message.

Returns the message collection.

getMessageCollection() : \EditableKeyValueCollection

Response

\EditableKeyValueCollection

Returns the message modification date time.

getModifiedDateTime() : \DateTime

Response

\DateTime

The modified date time.

Returns the message's source.

getSource() : string

Response

string

Source of the message.

Returns the status of the message.

getStatus() : string

Response

string

Status of the message.

Returns the type of the message.

getType() : string

Response

string

Returns the visibility of the message.

getVisibility() : string

Response

string

Visibility of the message.

Sets the message creation date time.

setAddedDateTime(\DateTime $dateTime) : \InfoBoxMessage

Arguments

$dateTime

\DateTime

Message added date time value.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the message button label.

setButtonLabel(\StringType $text, \LanguageCode $languageCode) : \InfoBoxMessage

Arguments

$text

\StringType

Button label text.

$languageCode

\LanguageCode

Button label text language code.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the button labels.

setButtonLabelCollection(\KeyValueCollection $buttonLabels) : \InfoBoxMessage

Arguments

$buttonLabels

\KeyValueCollection

Message button labels.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the link of the message button.

setButtonLink(\StringType $buttonLink) : \InfoBoxMessage

Arguments

$buttonLink

\StringType

Link of the message button.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the customer ID of the message.

setCustomerId(\IdType $customerId) : \InfoBoxMessage

Arguments

$customerId

\IdType

Customer ID of the message.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the message headline.

setHeadLine(\StringType $text, \LanguageCode $languageCode) : \InfoBoxMessage

Arguments

$text

\StringType

Message headline.

$languageCode

\LanguageCode

Language code for message headline.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the message headlines.

setHeadLineCollection(\KeyValueCollection $headlines) : \InfoBoxMessage

Arguments

$headlines

\KeyValueCollection

Message headlines.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the ID of the message.

setId(\IdType $id) : \InfoBoxMessage

Arguments

$id

\IdType

Identifier of the message.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the identifier string of the message

setIdentifier(\StringType $identifier) : \InfoBoxMessage

Arguments

$identifier

\StringType

Message identifier.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the message.

setMessage(\StringType $text, \LanguageCode $languageCode) : \InfoBoxMessage

Arguments

$text

\StringType

Message.

$languageCode

\LanguageCode

Language code of the message.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the messages by adding a collection.

setMessageCollection(\KeyValueCollection $messages) : \InfoBoxMessage

Arguments

$messages

\KeyValueCollection

Messages.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the message modification date time.

setModifiedDateTime(\DateTime $dateTime) : \InfoBoxMessage

Arguments

$dateTime

\DateTime

Message modification date time.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the message's source.

setSource(\StringType $source) : \InfoBoxMessage

Arguments

$source

\StringType

Source of the message (e.g. 'internal').

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the status of the message.

setStatus(\StringType $status) : \InfoBoxMessage

Arguments

$status

\StringType

Status of the message.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the type of the message.

setType(\StringType $type) : \InfoBoxMessage

Arguments

$type

\StringType

Type of the message.

Response

\InfoBoxMessage

Same instance for method chaining.

Sets the visibility of the message.

setVisibility(\StringType $visibility) : \InfoBoxMessage

Arguments

$visibility

\StringType

Visibility of the message.

Response

\InfoBoxMessage

Same instance for method chaining.

Properties

Message source

source : string
var

Type(s)

string

Message ID

id : string
var

Type(s)

string

Message identifier

identifier : string
var

Type(s)

string

Message status

status : string
var

Type(s)

string

Message type

type : string
var

Type(s)

string

Message visibility

visibility : string
var

Type(s)

string

Message button link.

buttonLink : string
var

Type(s)

string

Customer ID

customerId : integer
var

Type(s)

integer

Added date time.

addedDateTime : \DateTime
var

Type(s)

\DateTime

Modified date time.

modifiedDateTime : \DateTime
var

Type(s)

\DateTime

Message headlines

headlines : \EditableKeyValueCollection
var

Type(s)

\EditableKeyValueCollection

Messages

messages : \EditableKeyValueCollection
var

Type(s)

\EditableKeyValueCollection

Message button labels.

buttonLabels : \EditableKeyValueCollection
var

Type(s)

\EditableKeyValueCollection