LINE Messaging API SDK for PHP

RichMenuResponse
in package

LINE

Clients

MessagingApi

implements ModelInterface, ArrayAccess, JsonSerializable

RichMenuResponse Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

DISCRIMINATOR = null
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$openAPIFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$openAPIModelName : string: The original name of the model.
$openAPINullables : array<string|int, mixed>: Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull : array<string|int, mixed>: If a nullable field gets set to null, insert it here
$openAPITypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getAreas() : array<string|int, RichMenuArea>: Gets areas
getChatBarText() : string: Gets chatBarText
getModelName() : string: The original name of the model.
getName() : string: Gets name
getRichMenuId() : string: Gets richMenuId
getSelected() : bool: Gets selected
getSize() : RichMenuSize: Gets size
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
isNullable() : bool: Checks if a property is nullable
isNullableSetToNull() : bool: Checks if a nullable property is set to null.
jsonSerialize() : mixed: Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed|null: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
openAPIFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
openAPITypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
setAreas() : self: Sets areas
setChatBarText() : self: Sets chatBarText
setName() : self: Sets name
setRichMenuId() : self: Sets richMenuId
setSelected() : self: Sets selected
setSize() : self: Sets size
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
toHeaderValue() : string: Gets a header-safe presentation of the object
valid() : bool: Validate all the properties in the model return true if all passed
openAPINullables() : array<string|int, mixed>: Array of nullable properties
getOpenAPINullablesSetToNull() : array<string|int, bool>: Array of nullable field names deliberately set to null
setIfExists() : void: Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull() : void: Setter - Array of nullable field names deliberately set to null

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['richMenuId' => 'richMenuId', 'size' => 'size', 'selected' => 'selected', 'name' => 'name', 'chatBarText' => 'chatBarText', 'areas' => 'areas']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['richMenuId' => 'getRichMenuId', 'size' => 'getSize', 'selected' => 'getSelected', 'name' => 'getName', 'chatBarText' => 'getChatBarText', 'areas' => 'getAreas']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['richMenuId' => null, 'size' => null, 'selected' => null, 'name' => null, 'chatBarText' => null, 'areas' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'RichMenuResponse'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['richMenuId' => false, 'size' => false, 'selected' => false, 'name' => false, 'chatBarText' => false, 'areas' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here


    protected
        array<string|int, mixed>
    $openAPINullablesSetToNull
     = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $openAPITypes
     = ['richMenuId' => 'string', 'size' => '\\LINE\\Clients\\MessagingApi\\Model\\RichMenuSize', 'selected' => 'bool', 'name' => 'string', 'chatBarText' => 'string', 'areas' => '\\LINE\\Clients\\MessagingApi\\Model\\RichMenuArea[]']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['richMenuId' => 'setRichMenuId', 'size' => 'setSize', 'selected' => 'setSelected', 'name' => 'setName', 'chatBarText' => 'setChatBarText', 'areas' => 'setAreas']

__construct()

Constructor


    public
                    __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                    __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static        attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getAreas()

Gets areas


    public
                    getAreas() : array<string|int, RichMenuArea>

Return values

array<string|int, RichMenuArea> —

getChatBarText()

Gets chatBarText


    public
                    getChatBarText() : string

Return values

string —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getName()

Gets name


    public
                    getName() : string

Return values

string —

getRichMenuId()

Gets richMenuId


    public
                    getRichMenuId() : string

Return values

string —

getSelected()

Gets selected


    public
                    getSelected() : bool

Return values

bool —

getSize()

Gets size


    public
                    getSize() : RichMenuSize

Return values

RichMenuSize —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static        getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

isNullable()

Checks if a property is nullable


    public
            static        isNullable(string $property) : bool

Parameters

$property : string

Return values

bool —

isNullableSetToNull()

Checks if a nullable property is set to null.


    public
                    isNullableSetToNull(string $property) : bool

Parameters

$property : string

Return values

bool —

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().


    public
                    jsonSerialize() : mixed

Return values

mixed —

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                    listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                    offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                    offsetGet(int $offset) : mixed|null

Parameters

$offset : int: Offset

Return values

mixed|null —

offsetSet()

Sets value based on offset.


    public
                    offsetSet(int|null $offset, mixed $value) : void

Parameters

$offset : int|null: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

openAPIFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static        openAPIFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

openAPITypes()

Array of property to type mappings. Used for (de)serialization


    public
            static        openAPITypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setAreas()

Sets areas


    public
                    setAreas(array<string|int, RichMenuArea> $areas) : self

Parameters

$areas : array<string|int, RichMenuArea>: Array of area objects which define the coordinates and size of tappable areas

Return values

self —

setChatBarText()

Sets chatBarText


    public
                    setChatBarText(string $chatBarText) : self

Parameters

$chatBarText : string: Text displayed in the chat bar

Return values

self —

setName()

Sets name


    public
                    setName(string $name) : self

Parameters

$name : string: Name of the rich menu. This value can be used to help manage your rich menus and is not displayed to users.

Return values

self —

setRichMenuId()

Sets richMenuId


    public
                    setRichMenuId(string $richMenuId) : self

Parameters

$richMenuId : string: ID of a rich menu

Return values

self —

setSelected()

Sets selected


    public
                    setSelected(bool $selected) : self

Parameters

$selected : bool: true to display the rich menu by default. Otherwise, false.

Return values

self —

setSize()

Sets size


    public
                    setSize(RichMenuSize $size) : self

Parameters

$size : RichMenuSize: size

Return values

self —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static        setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

toHeaderValue()

Gets a header-safe presentation of the object


    public
                    toHeaderValue() : string

Return values

string —

valid()

Validate all the properties in the model return true if all passed


    public
                    valid() : bool

Return values

bool —

True if all properties are valid

openAPINullables()

Array of nullable properties


    protected
            static        openAPINullables() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null


    private
                    getOpenAPINullablesSetToNull() : array<string|int, bool>

Return values

array<string|int, bool> —

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array


    private
                    setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void

Parameters

$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

Return values

void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null


    private
                    setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void

Parameters

$openAPINullablesSetToNull : array<string|int, bool>

Return values

void —

RichMenuResponse in package LINE Clients MessagingApi implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAreas()

Return values

getChatBarText()

Return values

getModelName()

Return values

getName()

Return values

getRichMenuId()

Return values

getSelected()

Return values

getSize()

Return values

getters()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

offsetSet()

Parameters

Return values

offsetUnset()

Parameters

Return values

openAPIFormats()

Return values

openAPITypes()

Return values

setAreas()

Parameters

Return values

setChatBarText()

Parameters

Return values

setName()

Parameters

Return values

setRichMenuId()

Parameters

Return values

RichMenuResponse
in package

LINE

Clients

MessagingApi

implements ModelInterface, ArrayAccess, JsonSerializable