RichMenuBuilder
in package
A builder class for rich menu.
Table of Contents
- $areaBuilders : array<string|int, RichMenuAreaBuilder>
- $chatBarText : string
- $name : string
- $selected : bool
- $sizeBuilder : RichMenuSizeBuilder
- __construct() : mixed
- RichMenu constructor.
- build() : array<string|int, mixed>
- Builds message structure.
Properties
$areaBuilders
private
array<string|int, RichMenuAreaBuilder>
$areaBuilders
= []
$chatBarText
private
string
$chatBarText
$name
private
string
$name
$selected
private
bool
$selected
$sizeBuilder
private
RichMenuSizeBuilder
$sizeBuilder
Methods
__construct()
RichMenu constructor.
public
__construct(RichMenuSizeBuilder $sizeBuilder, bool $selected, string $name, string $chatBarText, array<string|int, RichMenuAreaBuilder> $areaBuilders) : mixed
Parameters
- $sizeBuilder : RichMenuSizeBuilder
-
size object which contains the width and height of the rich menu displayed in the chat.
- $selected : bool
-
true to display the rich menu by default. Otherwise, false.
- $name : string
-
Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.
- $chatBarText : string
-
Text displayed in the chat bar.
- $areaBuilders : array<string|int, RichMenuAreaBuilder>
Return values
mixed —build()
Builds message structure.
public
build() : array<string|int, mixed>
Return values
array<string|int, mixed> —Built message structure.