LINE Messaging API SDK for PHP

ScenarioResult
in package

LINE

Webhook

implements ModelInterface, ArrayAccess, JsonSerializable

ScenarioResult 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
getActionResults() : array<string|int, ActionResult>|null: Gets actionResults
getBleNotificationPayload() : string|null: Gets bleNotificationPayload
getEndTime() : int: Gets endTime
getErrorReason() : string|null: Gets errorReason
getModelName() : string: The original name of the model.
getResultCode() : string: Gets resultCode
getRevision() : int|null: Gets revision
getScenarioId() : string|null: Gets scenarioId
getStartTime() : int: Gets startTime
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
setActionResults() : self: Sets actionResults
setBleNotificationPayload() : self: Sets bleNotificationPayload
setEndTime() : self: Sets endTime
setErrorReason() : self: Sets errorReason
setResultCode() : self: Sets resultCode
setRevision() : self: Sets revision
setScenarioId() : self: Sets scenarioId
setStartTime() : self: Sets startTime
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
     = ['scenarioId' => 'scenarioId', 'revision' => 'revision', 'startTime' => 'startTime', 'endTime' => 'endTime', 'resultCode' => 'resultCode', 'actionResults' => 'actionResults', 'bleNotificationPayload' => 'bleNotificationPayload', 'errorReason' => 'errorReason']

$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
     = ['scenarioId' => 'getScenarioId', 'revision' => 'getRevision', 'startTime' => 'getStartTime', 'endTime' => 'getEndTime', 'resultCode' => 'getResultCode', 'actionResults' => 'getActionResults', 'bleNotificationPayload' => 'getBleNotificationPayload', 'errorReason' => 'getErrorReason']

$openAPIFormats

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


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['scenarioId' => null, 'revision' => null, 'startTime' => 'int64', 'endTime' => 'int64', 'resultCode' => null, 'actionResults' => null, 'bleNotificationPayload' => null, 'errorReason' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'ScenarioResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['scenarioId' => false, 'revision' => false, 'startTime' => false, 'endTime' => false, 'resultCode' => false, 'actionResults' => false, 'bleNotificationPayload' => false, 'errorReason' => 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
     = ['scenarioId' => 'string', 'revision' => 'int', 'startTime' => 'int', 'endTime' => 'int', 'resultCode' => 'string', 'actionResults' => '\\LINE\\Webhook\\Model\\ActionResult[]', 'bleNotificationPayload' => 'string', 'errorReason' => 'string']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['scenarioId' => 'setScenarioId', 'revision' => 'setRevision', 'startTime' => 'setStartTime', 'endTime' => 'setEndTime', 'resultCode' => 'setResultCode', 'actionResults' => 'setActionResults', 'bleNotificationPayload' => 'setBleNotificationPayload', 'errorReason' => 'setErrorReason']

__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> —

getActionResults()

Gets actionResults


    public
                    getActionResults() : array<string|int, ActionResult>|null

Return values

array<string|int, ActionResult>|null —

getBleNotificationPayload()

Gets bleNotificationPayload


    public
                    getBleNotificationPayload() : string|null

Return values

string|null —

getEndTime()

Gets endTime


    public
                    getEndTime() : int

Return values

int —

getErrorReason()

Gets errorReason


    public
                    getErrorReason() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getResultCode()

Gets resultCode


    public
                    getResultCode() : string

Return values

string —

getRevision()

Gets revision


    public
                    getRevision() : int|null

Return values

int|null —

getScenarioId()

Gets scenarioId


    public
                    getScenarioId() : string|null

Return values

string|null —

getStartTime()

Gets startTime


    public
                    getStartTime() : int

Return values

int —

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> —

setActionResults()

Sets actionResults


    public
                    setActionResults(array<string|int, ActionResult>|null $actionResults) : self

Parameters

$actionResults : array<string|int, ActionResult>|null: Execution result of individual operations specified in action. Only included when things.result.resultCode is success.

Return values

self —

setBleNotificationPayload()

Sets bleNotificationPayload


    public
                    setBleNotificationPayload(string|null $bleNotificationPayload) : self

Parameters

$bleNotificationPayload : string|null: Data contained in notification.

Return values

self —

setEndTime()

Sets endTime


    public
                    setEndTime(int $endTime) : self

Parameters

$endTime : int: Timestamp for when execution of scenario was completed (milliseconds, LINE app time)

Return values

self —

setErrorReason()

Sets errorReason


    public
                    setErrorReason(string|null $errorReason) : self

Parameters

$errorReason : string|null: Error reason.

Return values

self —

setResultCode()

Sets resultCode


    public
                    setResultCode(string $resultCode) : self

Parameters

$resultCode : string: Scenario execution completion status

Return values

self —

setRevision()

Sets revision


    public
                    setRevision(int|null $revision) : self

Parameters

$revision : int|null: Revision number of the scenario set containing the executed scenario

Return values

self —

setScenarioId()

Sets scenarioId


    public
                    setScenarioId(string|null $scenarioId) : self

Parameters

$scenarioId : string|null: Scenario ID executed

Return values

self —

setStartTime()

Sets startTime


    public
                    setStartTime(int $startTime) : self

Parameters

$startTime : int: Timestamp for when execution of scenario action started (milliseconds, LINE app time)

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 —

ScenarioResult in package LINE Webhook 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

getActionResults()

Return values

getBleNotificationPayload()

Return values

getEndTime()

Return values

getErrorReason()

Return values

getModelName()

Return values

getResultCode()

Return values

getRevision()

Return values

getScenarioId()

Return values

getStartTime()

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

setActionResults()

Parameters

Return values

setBleNotificationPayload()

Parameters

Return values

setEndTime()

Parameters

ScenarioResult
in package

LINE

Webhook

implements ModelInterface, ArrayAccess, JsonSerializable