ButtonsTemplate
extends Template
in package
ButtonsTemplate Class Doc Comment
Tags
Table of Contents
- 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
- getActions() : array<string|int, Action>
- Gets actions
- getDefaultAction() : Action|null
- Gets defaultAction
- getImageAspectRatio() : string|null
- Gets imageAspectRatio
- getImageBackgroundColor() : string|null
- Gets imageBackgroundColor
- getImageSize() : string|null
- Gets imageSize
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getText() : string
- Gets text
- getThumbnailImageUrl() : string|null
- Gets thumbnailImageUrl
- getTitle() : string|null
- Gets title
- getType() : string
- Gets type
- 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
- setActions() : self
- Sets actions
- setDefaultAction() : self
- Sets defaultAction
- setImageAspectRatio() : self
- Sets imageAspectRatio
- setImageBackgroundColor() : self
- Sets imageBackgroundColor
- setImageSize() : self
- Sets imageSize
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setText() : self
- Sets text
- setThumbnailImageUrl() : self
- Sets thumbnailImageUrl
- setTitle() : self
- Sets title
- setType() : self
- Sets type
- 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
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$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
= ['thumbnailImageUrl' => 'thumbnailImageUrl', 'imageAspectRatio' => 'imageAspectRatio', 'imageSize' => 'imageSize', 'imageBackgroundColor' => 'imageBackgroundColor', 'title' => 'title', 'text' => 'text', 'defaultAction' => 'defaultAction', 'actions' => 'actions']
$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
= ['thumbnailImageUrl' => 'getThumbnailImageUrl', 'imageAspectRatio' => 'getImageAspectRatio', 'imageSize' => 'getImageSize', 'imageBackgroundColor' => 'getImageBackgroundColor', 'title' => 'getTitle', 'text' => 'getText', 'defaultAction' => 'getDefaultAction', 'actions' => 'getActions']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['thumbnailImageUrl' => 'uri', 'imageAspectRatio' => null, 'imageSize' => null, 'imageBackgroundColor' => null, 'title' => null, 'text' => null, 'defaultAction' => null, 'actions' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ButtonsTemplate'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['thumbnailImageUrl' => false, 'imageAspectRatio' => false, 'imageSize' => false, 'imageBackgroundColor' => false, 'title' => false, 'text' => false, 'defaultAction' => false, 'actions' => 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
= ['thumbnailImageUrl' => 'string', 'imageAspectRatio' => 'string', 'imageSize' => 'string', 'imageBackgroundColor' => 'string', 'title' => 'string', 'text' => 'string', 'defaultAction' => '\\LINE\\Clients\\MessagingApi\\Model\\Action', 'actions' => '\\LINE\\Clients\\MessagingApi\\Model\\Action[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['thumbnailImageUrl' => 'setThumbnailImageUrl', 'imageAspectRatio' => 'setImageAspectRatio', 'imageSize' => 'setImageSize', 'imageBackgroundColor' => 'setImageBackgroundColor', 'title' => 'setTitle', 'text' => 'setText', 'defaultAction' => 'setDefaultAction', 'actions' => 'setActions']
Methods
__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> —getActions()
Gets actions
public
getActions() : array<string|int, Action>
Return values
array<string|int, Action> —getDefaultAction()
Gets defaultAction
public
getDefaultAction() : Action|null
Return values
Action|null —getImageAspectRatio()
Gets imageAspectRatio
public
getImageAspectRatio() : string|null
Return values
string|null —getImageBackgroundColor()
Gets imageBackgroundColor
public
getImageBackgroundColor() : string|null
Return values
string|null —getImageSize()
Gets imageSize
public
getImageSize() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getText()
Gets text
public
getText() : string
Return values
string —getThumbnailImageUrl()
Gets thumbnailImageUrl
public
getThumbnailImageUrl() : string|null
Return values
string|null —getTitle()
Gets title
public
getTitle() : string|null
Return values
string|null —getType()
Gets type
public
getType() : string
Return values
string —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
Tags
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> —setActions()
Sets actions
public
setActions(array<string|int, Action> $actions) : self
Parameters
- $actions : array<string|int, Action>
-
actions
Return values
self —setDefaultAction()
Sets defaultAction
public
setDefaultAction(Action|null $defaultAction) : self
Parameters
- $defaultAction : Action|null
-
defaultAction
Return values
self —setImageAspectRatio()
Sets imageAspectRatio
public
setImageAspectRatio(string|null $imageAspectRatio) : self
Parameters
- $imageAspectRatio : string|null
-
imageAspectRatio
Return values
self —setImageBackgroundColor()
Sets imageBackgroundColor
public
setImageBackgroundColor(string|null $imageBackgroundColor) : self
Parameters
- $imageBackgroundColor : string|null
-
imageBackgroundColor
Return values
self —setImageSize()
Sets imageSize
public
setImageSize(string|null $imageSize) : self
Parameters
- $imageSize : string|null
-
imageSize
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> —setText()
Sets text
public
setText(string $text) : self
Parameters
- $text : string
-
text
Return values
self —setThumbnailImageUrl()
Sets thumbnailImageUrl
public
setThumbnailImageUrl(string|null $thumbnailImageUrl) : self
Parameters
- $thumbnailImageUrl : string|null
-
thumbnailImageUrl
Return values
self —setTitle()
Sets title
public
setTitle(string|null $title) : self
Parameters
- $title : string|null
-
title
Return values
self —setType()
Sets type
public
setType(string $type) : self
Parameters
- $type : string
-
type
Return values
self —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>