LiffApp
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
LiffApp Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
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
- getBotPrompt() : LiffBotPrompt|null
- Gets botPrompt
- getDescription() : string|null
- Gets description
- getFeatures() : LiffFeatures|null
- Gets features
- getLiffId() : string|null
- Gets liffId
- getModelName() : string
- The original name of the model.
- getPermanentLinkPattern() : string|null
- Gets permanentLinkPattern
- getScope() : array<string|int, LiffScope>|null
- Gets scope
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getView() : LiffView|null
- Gets view
- 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
- setBotPrompt() : self
- Sets botPrompt
- setDescription() : self
- Sets description
- setFeatures() : self
- Sets features
- setLiffId() : self
- Sets liffId
- setPermanentLinkPattern() : self
- Sets permanentLinkPattern
- setScope() : self
- Sets scope
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setView() : self
- Sets view
- 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
= ['liffId' => 'liffId', 'view' => 'view', 'description' => 'description', 'features' => 'features', 'permanentLinkPattern' => 'permanentLinkPattern', 'scope' => 'scope', 'botPrompt' => 'botPrompt']
$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
= ['liffId' => 'getLiffId', 'view' => 'getView', 'description' => 'getDescription', 'features' => 'getFeatures', 'permanentLinkPattern' => 'getPermanentLinkPattern', 'scope' => 'getScope', 'botPrompt' => 'getBotPrompt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['liffId' => null, 'view' => null, 'description' => null, 'features' => null, 'permanentLinkPattern' => null, 'scope' => null, 'botPrompt' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'LiffApp'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['liffId' => false, 'view' => false, 'description' => false, 'features' => false, 'permanentLinkPattern' => false, 'scope' => false, 'botPrompt' => 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
= ['liffId' => 'string', 'view' => '\\LINE\\Clients\\Liff\\Model\\LiffView', 'description' => 'string', 'features' => '\\LINE\\Clients\\Liff\\Model\\LiffFeatures', 'permanentLinkPattern' => 'string', 'scope' => '\\LINE\\Clients\\Liff\\Model\\LiffScope[]', 'botPrompt' => '\\LINE\\Clients\\Liff\\Model\\LiffBotPrompt']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['liffId' => 'setLiffId', 'view' => 'setView', 'description' => 'setDescription', 'features' => 'setFeatures', 'permanentLinkPattern' => 'setPermanentLinkPattern', 'scope' => 'setScope', 'botPrompt' => 'setBotPrompt']
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> —getBotPrompt()
Gets botPrompt
public
getBotPrompt() : LiffBotPrompt|null
Return values
LiffBotPrompt|null —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getFeatures()
Gets features
public
getFeatures() : LiffFeatures|null
Return values
LiffFeatures|null —getLiffId()
Gets liffId
public
getLiffId() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPermanentLinkPattern()
Gets permanentLinkPattern
public
getPermanentLinkPattern() : string|null
Return values
string|null —getScope()
Gets scope
public
getScope() : array<string|int, LiffScope>|null
Return values
array<string|int, LiffScope>|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getView()
Gets view
public
getView() : LiffView|null
Return values
LiffView|null —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> —setBotPrompt()
Sets botPrompt
public
setBotPrompt(LiffBotPrompt|null $botPrompt) : self
Parameters
- $botPrompt : LiffBotPrompt|null
-
botPrompt
Return values
self —setDescription()
Sets description
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
-
Name of the LIFF app
Return values
self —setFeatures()
Sets features
public
setFeatures(LiffFeatures|null $features) : self
Parameters
- $features : LiffFeatures|null
-
features
Return values
self —setLiffId()
Sets liffId
public
setLiffId(string|null $liffId) : self
Parameters
- $liffId : string|null
-
LIFF app ID
Return values
self —setPermanentLinkPattern()
Sets permanentLinkPattern
public
setPermanentLinkPattern(string|null $permanentLinkPattern) : self
Parameters
- $permanentLinkPattern : string|null
-
How additional information in LIFF URLs is handled. concat is returned.
Return values
self —setScope()
Sets scope
public
setScope(array<string|int, LiffScope>|null $scope) : self
Parameters
- $scope : array<string|int, LiffScope>|null
-
scope
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> —setView()
Sets view
public
setView(LiffView|null $view) : self
Parameters
- $view : LiffView|null
-
view
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>