Interface InfoBoxMessageInterface

Direct known implementers

InfoBoxMessage

Package: InfoBox\Interfaces
Category: System
Located at Services/Core/InfoBox/Entities/Interfaces/InfoBoxMessageInterface.php

Methods summary

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

Packages

Classes

Interfaces

Interface InfoBoxMessageInterface

Direct known implementers

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns