FlexMessageBuilder
in package
implements
MessageBuilder
A builder class for flex message.
Interfaces, Classes and Traits
- MessageBuilder
- The interface that has a responsibility to build message.
Table of Contents
- $altText : string
- $containerBuilder : ContainerBuilder
- $message : array<string|int, mixed>|null
- $quickReply : QuickReplyBuilder|null
- $sender : SenderBuilder|null
- __construct() : mixed
- FlexMessageBuilder constructor.
- builder() : FlexMessageBuilder
- Create empty FlexMessageBuilder.
- buildMessage() : array<string|int, mixed>
- Builds flex message structure.
- setAltText() : FlexMessageBuilder
- Set altText.
- setContents() : FlexMessageBuilder
- Set contents.
- setQuickReply() : FlexMessageBuilder
- Set quickReply.
- setSender() : FlexMessageBuilder
- Set sender.
Properties
$altText
private
string
$altText
$containerBuilder
private
ContainerBuilder
$containerBuilder
$message
private
array<string|int, mixed>|null
$message
$quickReply
private
QuickReplyBuilder|null
$quickReply
$sender
private
SenderBuilder|null
$sender
Methods
__construct()
FlexMessageBuilder constructor.
public
__construct(string|null $altText, ContainerBuilder|null $containerBuilder[, QuickReplyBuilder|null $quickReply = null ][, SenderBuilder|null $sender = null ]) : mixed
Parameters
- $altText : string|null
- $containerBuilder : ContainerBuilder|null
- $quickReply : QuickReplyBuilder|null = null
- $sender : SenderBuilder|null = null
Return values
mixed —builder()
Create empty FlexMessageBuilder.
public
static builder() : FlexMessageBuilder
Return values
FlexMessageBuilder —buildMessage()
Builds flex message structure.
public
buildMessage() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAltText()
Set altText.
public
setAltText(string $altText) : FlexMessageBuilder
Parameters
- $altText : string
Return values
FlexMessageBuilder —setContents()
Set contents.
public
setContents(ContainerBuilder $containerBuilder) : FlexMessageBuilder
Parameters
- $containerBuilder : ContainerBuilder
Return values
FlexMessageBuilder —setQuickReply()
Set quickReply.
public
setQuickReply([QuickReplyBuilder|null $quickReply = null ]) : FlexMessageBuilder
Parameters
- $quickReply : QuickReplyBuilder|null = null
Return values
FlexMessageBuilder —setSender()
Set sender.
public
setSender([SenderBuilder|null $sender = null ]) : FlexMessageBuilder
Parameters
- $sender : SenderBuilder|null = null