InfoBoxMessageInterface
in
Interface InfoBoxMessageInterface
Tags
Table of Contents
- getAddedDateTime() : DateTime
- Returns the message creation date time.
- getButtonLabel() : string
- Returns the message button label.
- getButtonLabelCollection() : EditableKeyValueCollection
- Returns the button label collection.
- getButtonLink() : string
- Returns the link of the message button.
- getCustomerId() : int
- Returns the customer ID of the message.
- getHeadLine() : string
- Returns the message headline.
- getHeadLineCollection() : EditableKeyValueCollection
- Returns the headline collection.
- getId() : int
- Returns the ID of the message.
- getIdentifier() : string
- Returns the message identifier.
- getMessage() : string
- Returns the message.
- getMessageCollection() : EditableKeyValueCollection
- Returns the message collection.
- getModifiedDateTime() : DateTime
- Returns the message modification date time.
- getSource() : string
- Returns the message's source.
- getStatus() : string
- Returns the status of the message.
- getType() : string
- Returns the type of the message.
- getVisibility() : string
- Returns the visibility of the message.
- setAddedDateTime() : InfoBoxMessageInterface
- Sets the message creation date time.
- setButtonLabel() : InfoBoxMessageInterface
- Sets the message button label.
- setButtonLabelCollection() : InfoBoxMessageInterface
- Sets the button labels.
- setButtonLink() : InfoBoxMessageInterface
- Sets the link of the message button.
- setCustomerId() : InfoBoxMessageInterface
- Sets the customer ID of the message.
- setHeadLine() : InfoBoxMessageInterface
- Sets the message headline.
- setHeadLineCollection() : InfoBoxMessageInterface
- Sets the message headlines.
- setId() : InfoBoxMessageInterface
- Sets the ID of the message.
- setIdentifier() : InfoBoxMessageInterface
- Sets the identifier string of the message
- setMessage() : InfoBoxMessageInterface
- Sets the message.
- setMessageCollection() : InfoBoxMessageInterface
- Sets the messages by adding a collection.
- setModifiedDateTime() : InfoBoxMessageInterface
- Sets the message modification date time.
- setSource() : InfoBoxMessageInterface
- Sets the message's source.
- setStatus() : InfoBoxMessageInterface
- Sets the status of the message.
- setType() : InfoBoxMessageInterface
- Sets the type of the message.
- setVisibility() : InfoBoxMessageInterface
- Sets the visibility of the message.
Methods
getAddedDateTime()
Returns the message creation date time.
public
getAddedDateTime() : DateTime
Return values
DateTime —The added date time.
getButtonLabel()
Returns the message button label.
public
getButtonLabel(LanguageCode $languageCode) : string
Parameters
- $languageCode : LanguageCode
-
Button label language code.
Return values
string —The message button label.
getButtonLabelCollection()
Returns the button label collection.
public
getButtonLabelCollection() : EditableKeyValueCollection
Return values
EditableKeyValueCollection —getButtonLink()
Returns the link of the message button.
public
getButtonLink() : string
Return values
string —Link of the message button.
getCustomerId()
Returns the customer ID of the message.
public
getCustomerId() : int
Return values
int —getHeadLine()
Returns the message headline.
public
getHeadLine(LanguageCode $languageCode) : string
Parameters
- $languageCode : LanguageCode
-
Language code of the message headline.
Return values
string —The message headline.
getHeadLineCollection()
Returns the headline collection.
public
getHeadLineCollection() : EditableKeyValueCollection
Return values
EditableKeyValueCollection —getId()
Returns the ID of the message.
public
getId() : int
Return values
int —ID of the message.
getIdentifier()
Returns the message identifier.
public
getIdentifier() : string
Return values
string —Message identifier.
getMessage()
Returns the message.
public
getMessage(LanguageCode $languageCode) : string
Parameters
- $languageCode : LanguageCode
-
Language code of the message.
Return values
string —The message.
getMessageCollection()
Returns the message collection.
public
getMessageCollection() : EditableKeyValueCollection
Return values
EditableKeyValueCollection —getModifiedDateTime()
Returns the message modification date time.
public
getModifiedDateTime() : DateTime
Return values
DateTime —The modified date time.
getSource()
Returns the message's source.
public
getSource() : string
Return values
string —Source of the message.
getStatus()
Returns the status of the message.
public
getStatus() : string
Return values
string —Status of the message.
getType()
Returns the type of the message.
public
getType() : string
Return values
string —getVisibility()
Returns the visibility of the message.
public
getVisibility() : string
Return values
string —Visibility of the message.
setAddedDateTime()
Sets the message creation date time.
public
setAddedDateTime(DateTime $dateTime) : InfoBoxMessageInterface
Parameters
- $dateTime : DateTime
-
Message added date time value.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setButtonLabel()
Sets the message button label.
public
setButtonLabel(StringType $text, LanguageCode $languageCode) : InfoBoxMessageInterface
Parameters
- $text : StringType
-
Button label text.
- $languageCode : LanguageCode
-
Button label text language code.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setButtonLabelCollection()
Sets the button labels.
public
setButtonLabelCollection(KeyValueCollection $buttonLabels) : InfoBoxMessageInterface
Parameters
- $buttonLabels : KeyValueCollection
-
Message button labels.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setButtonLink()
Sets the link of the message button.
public
setButtonLink(StringType $buttonLink) : InfoBoxMessageInterface
Parameters
- $buttonLink : StringType
-
Link of the message button.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setCustomerId()
Sets the customer ID of the message.
public
setCustomerId(IdType $customerId) : InfoBoxMessageInterface
Parameters
- $customerId : IdType
-
Customer ID of the message.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setHeadLine()
Sets the message headline.
public
setHeadLine(StringType $text, LanguageCode $languageCode) : InfoBoxMessageInterface
Parameters
- $text : StringType
-
Message headline.
- $languageCode : LanguageCode
-
Language code for message headline.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setHeadLineCollection()
Sets the message headlines.
public
setHeadLineCollection(KeyValueCollection $headlines) : InfoBoxMessageInterface
Parameters
- $headlines : KeyValueCollection
-
Message headlines.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setId()
Sets the ID of the message.
public
setId(IdType $id) : InfoBoxMessageInterface
Parameters
- $id : IdType
-
Identifier of the message.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setIdentifier()
Sets the identifier string of the message
public
setIdentifier(StringType $identifier) : InfoBoxMessageInterface
Parameters
- $identifier : StringType
-
Message identifier.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setMessage()
Sets the message.
public
setMessage(StringType $text, LanguageCode $languageCode) : InfoBoxMessageInterface
Parameters
- $text : StringType
-
Message.
- $languageCode : LanguageCode
-
Language code of the message.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setMessageCollection()
Sets the messages by adding a collection.
public
setMessageCollection(KeyValueCollection $messages) : InfoBoxMessageInterface
Parameters
- $messages : KeyValueCollection
-
Messages.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setModifiedDateTime()
Sets the message modification date time.
public
setModifiedDateTime(DateTime $dateTime) : InfoBoxMessageInterface
Parameters
- $dateTime : DateTime
-
Message modification date time.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setSource()
Sets the message's source.
public
setSource(StringType $source) : InfoBoxMessageInterface
Parameters
- $source : StringType
-
Source of the message (e.g. 'internal').
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setStatus()
Sets the status of the message.
public
setStatus(StringType $status) : InfoBoxMessageInterface
Parameters
- $status : StringType
-
Status of the message.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setType()
Sets the type of the message.
public
setType(StringType $type) : InfoBoxMessageInterface
Parameters
- $type : StringType
-
Type of the message.
Return values
InfoBoxMessageInterface —Same instance for method chaining.
setVisibility()
Sets the visibility of the message.
public
setVisibility(StringType $visibility) : InfoBoxMessageInterface
Parameters
- $visibility : StringType
-
Visibility of the message.
Return values
InfoBoxMessageInterface —Same instance for method chaining.