LINE Messaging API SDK for PHP

GetMessageEventResponseMessage
in package

LINE

Clients

Insight

implements ModelInterface, ArrayAccess, JsonSerializable

GetMessageEventResponseMessage Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR = null

Properties

$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, bool>: Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull : array<string|int, bool>: 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)

Methods

__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
getImpression() : int|null: Gets impression
getMediaPlayed() : int|null: Gets mediaPlayed
getMediaPlayed100Percent() : int|null: Gets mediaPlayed100Percent
getMediaPlayed25Percent() : int|null: Gets mediaPlayed25Percent
getMediaPlayed50Percent() : int|null: Gets mediaPlayed50Percent
getMediaPlayed75Percent() : int|null: Gets mediaPlayed75Percent
getModelName() : string: The original name of the model.
getSeq() : int|null: Gets seq
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getUniqueMediaPlayed() : int|null: Gets uniqueMediaPlayed
getUniqueMediaPlayed100Percent() : int|null: Gets uniqueMediaPlayed100Percent
getUniqueMediaPlayed25Percent() : int|null: Gets uniqueMediaPlayed25Percent
getUniqueMediaPlayed50Percent() : int|null: Gets uniqueMediaPlayed50Percent
getUniqueMediaPlayed75Percent() : int|null: Gets uniqueMediaPlayed75Percent
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
setImpression() : self: Sets impression
setMediaPlayed() : self: Sets mediaPlayed
setMediaPlayed100Percent() : self: Sets mediaPlayed100Percent
setMediaPlayed25Percent() : self: Sets mediaPlayed25Percent
setMediaPlayed50Percent() : self: Sets mediaPlayed50Percent
setMediaPlayed75Percent() : self: Sets mediaPlayed75Percent
setSeq() : self: Sets seq
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setUniqueMediaPlayed() : self: Sets uniqueMediaPlayed
setUniqueMediaPlayed100Percent() : self: Sets uniqueMediaPlayed100Percent
setUniqueMediaPlayed25Percent() : self: Sets uniqueMediaPlayed25Percent
setUniqueMediaPlayed50Percent() : self: Sets uniqueMediaPlayed50Percent
setUniqueMediaPlayed75Percent() : self: Sets uniqueMediaPlayed75Percent
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
     = ['seq' => 'seq', 'impression' => 'impression', 'mediaPlayed' => 'mediaPlayed', 'mediaPlayed25Percent' => 'mediaPlayed25Percent', 'mediaPlayed50Percent' => 'mediaPlayed50Percent', 'mediaPlayed75Percent' => 'mediaPlayed75Percent', 'mediaPlayed100Percent' => 'mediaPlayed100Percent', 'uniqueMediaPlayed' => 'uniqueMediaPlayed', 'uniqueMediaPlayed25Percent' => 'uniqueMediaPlayed25Percent', 'uniqueMediaPlayed50Percent' => 'uniqueMediaPlayed50Percent', 'uniqueMediaPlayed75Percent' => 'uniqueMediaPlayed75Percent', 'uniqueMediaPlayed100Percent' => 'uniqueMediaPlayed100Percent']

$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
     = ['seq' => 'getSeq', 'impression' => 'getImpression', 'mediaPlayed' => 'getMediaPlayed', 'mediaPlayed25Percent' => 'getMediaPlayed25Percent', 'mediaPlayed50Percent' => 'getMediaPlayed50Percent', 'mediaPlayed75Percent' => 'getMediaPlayed75Percent', 'mediaPlayed100Percent' => 'getMediaPlayed100Percent', 'uniqueMediaPlayed' => 'getUniqueMediaPlayed', 'uniqueMediaPlayed25Percent' => 'getUniqueMediaPlayed25Percent', 'uniqueMediaPlayed50Percent' => 'getUniqueMediaPlayed50Percent', 'uniqueMediaPlayed75Percent' => 'getUniqueMediaPlayed75Percent', 'uniqueMediaPlayed100Percent' => 'getUniqueMediaPlayed100Percent']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['seq' => 'int32', 'impression' => 'int64', 'mediaPlayed' => 'int64', 'mediaPlayed25Percent' => 'int64', 'mediaPlayed50Percent' => 'int64', 'mediaPlayed75Percent' => 'int64', 'mediaPlayed100Percent' => 'int64', 'uniqueMediaPlayed' => 'int64', 'uniqueMediaPlayed25Percent' => 'int64', 'uniqueMediaPlayed50Percent' => 'int64', 'uniqueMediaPlayed75Percent' => 'int64', 'uniqueMediaPlayed100Percent' => 'int64']

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'GetMessageEventResponseMessage'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['seq' => false, 'impression' => true, 'mediaPlayed' => true, 'mediaPlayed25Percent' => true, 'mediaPlayed50Percent' => true, 'mediaPlayed75Percent' => true, 'mediaPlayed100Percent' => true, 'uniqueMediaPlayed' => true, 'uniqueMediaPlayed25Percent' => true, 'uniqueMediaPlayed50Percent' => true, 'uniqueMediaPlayed75Percent' => true, 'uniqueMediaPlayed100Percent' => true]

$openAPINullablesSetToNull

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


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

$openAPITypes

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


        protected
        static    array<string|int, string>
    $openAPITypes
     = ['seq' => 'int', 'impression' => 'int', 'mediaPlayed' => 'int', 'mediaPlayed25Percent' => 'int', 'mediaPlayed50Percent' => 'int', 'mediaPlayed75Percent' => 'int', 'mediaPlayed100Percent' => 'int', 'uniqueMediaPlayed' => 'int', 'uniqueMediaPlayed25Percent' => 'int', 'uniqueMediaPlayed50Percent' => 'int', 'uniqueMediaPlayed75Percent' => 'int', 'uniqueMediaPlayed100Percent' => 'int']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['seq' => 'setSeq', 'impression' => 'setImpression', 'mediaPlayed' => 'setMediaPlayed', 'mediaPlayed25Percent' => 'setMediaPlayed25Percent', 'mediaPlayed50Percent' => 'setMediaPlayed50Percent', 'mediaPlayed75Percent' => 'setMediaPlayed75Percent', 'mediaPlayed100Percent' => 'setMediaPlayed100Percent', 'uniqueMediaPlayed' => 'setUniqueMediaPlayed', 'uniqueMediaPlayed25Percent' => 'setUniqueMediaPlayed25Percent', 'uniqueMediaPlayed50Percent' => 'setUniqueMediaPlayed50Percent', 'uniqueMediaPlayed75Percent' => 'setUniqueMediaPlayed75Percent', 'uniqueMediaPlayed100Percent' => 'setUniqueMediaPlayed100Percent']

__construct()

Constructor


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

Parameters

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

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

getImpression()

Gets impression


    public
                    getImpression() : int|null

Return values

int|null

getMediaPlayed()

Gets mediaPlayed


    public
                    getMediaPlayed() : int|null

Return values

int|null

getMediaPlayed100Percent()

Gets mediaPlayed100Percent


    public
                    getMediaPlayed100Percent() : int|null

Return values

int|null

getMediaPlayed25Percent()

Gets mediaPlayed25Percent


    public
                    getMediaPlayed25Percent() : int|null

Return values

int|null

getMediaPlayed50Percent()

Gets mediaPlayed50Percent


    public
                    getMediaPlayed50Percent() : int|null

Return values

int|null

getMediaPlayed75Percent()

Gets mediaPlayed75Percent


    public
                    getMediaPlayed75Percent() : int|null

Return values

int|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getSeq()

Gets seq


    public
                    getSeq() : int|null

Return values

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

getUniqueMediaPlayed()

Gets uniqueMediaPlayed


    public
                    getUniqueMediaPlayed() : int|null

Return values

int|null

getUniqueMediaPlayed100Percent()

Gets uniqueMediaPlayed100Percent


    public
                    getUniqueMediaPlayed100Percent() : int|null

Return values

int|null

getUniqueMediaPlayed25Percent()

Gets uniqueMediaPlayed25Percent


    public
                    getUniqueMediaPlayed25Percent() : int|null

Return values

int|null

getUniqueMediaPlayed50Percent()

Gets uniqueMediaPlayed50Percent


    public
                    getUniqueMediaPlayed50Percent() : int|null

Return values

int|null

getUniqueMediaPlayed75Percent()

Gets uniqueMediaPlayed75Percent


    public
                    getUniqueMediaPlayed75Percent() : int|null

Return values

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

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

#[ReturnTypeWillChange]

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

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

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>

setImpression()

Sets impression


    public
                    setImpression(int|null $impression) : self

Parameters

$impression : int|null: Number of times the bubble was displayed.

Return values

self

setMediaPlayed()

Sets mediaPlayed


    public
                    setMediaPlayed(int|null $mediaPlayed) : self

Parameters

$mediaPlayed : int|null: Number of times audio or video in the bubble started playing.

Return values

self

setMediaPlayed100Percent()

Sets mediaPlayed100Percent


    public
                    setMediaPlayed100Percent(int|null $mediaPlayed100Percent) : self

Parameters

$mediaPlayed100Percent : int|null: Number of times audio or video in the bubble started playing and was played 100% of the total time.

Return values

self

setMediaPlayed25Percent()

Sets mediaPlayed25Percent


    public
                    setMediaPlayed25Percent(int|null $mediaPlayed25Percent) : self

Parameters

$mediaPlayed25Percent : int|null: Number of times audio or video in the bubble started playing and was played 25% of the total time.

Return values

self

setMediaPlayed50Percent()

Sets mediaPlayed50Percent


    public
                    setMediaPlayed50Percent(int|null $mediaPlayed50Percent) : self

Parameters

$mediaPlayed50Percent : int|null: Number of times audio or video in the bubble started playing and was played 50% of the total time.

Return values

self

setMediaPlayed75Percent()

Sets mediaPlayed75Percent


    public
                    setMediaPlayed75Percent(int|null $mediaPlayed75Percent) : self

Parameters

$mediaPlayed75Percent : int|null: Number of times audio or video in the bubble started playing and was played 75% of the total time.

Return values

self

setSeq()

Sets seq


    public
                    setSeq(int|null $seq) : self

Parameters

$seq : int|null: Bubble's serial number.

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>

setUniqueMediaPlayed()

Sets uniqueMediaPlayed


    public
                    setUniqueMediaPlayed(int|null $uniqueMediaPlayed) : self

Parameters

$uniqueMediaPlayed : int|null: Number of users that started playing audio or video in the bubble.

Return values

self

setUniqueMediaPlayed100Percent()

Sets uniqueMediaPlayed100Percent


    public
                    setUniqueMediaPlayed100Percent(int|null $uniqueMediaPlayed100Percent) : self

Parameters

$uniqueMediaPlayed100Percent : int|null: Number of users that started playing audio or video in the bubble and played 100% of the total time.

Return values

self

setUniqueMediaPlayed25Percent()

Sets uniqueMediaPlayed25Percent


    public
                    setUniqueMediaPlayed25Percent(int|null $uniqueMediaPlayed25Percent) : self

Parameters

$uniqueMediaPlayed25Percent : int|null: Number of users that started playing audio or video in the bubble and played 25% of the total time.

Return values

self

setUniqueMediaPlayed50Percent()

Sets uniqueMediaPlayed50Percent


    public
                    setUniqueMediaPlayed50Percent(int|null $uniqueMediaPlayed50Percent) : self

Parameters

$uniqueMediaPlayed50Percent : int|null: Number of users that started playing audio or video in the bubble and played 50% of the total time.

Return values

self

setUniqueMediaPlayed75Percent()

Sets uniqueMediaPlayed75Percent


    public
                    setUniqueMediaPlayed75Percent(int|null $uniqueMediaPlayed75Percent) : self

Parameters

$uniqueMediaPlayed75Percent : int|null: Number of users that started playing audio or video in the bubble and played 75% of the total time.

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

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>

GetMessageEventResponseMessage in package LINE Clients Insight implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getImpression()

Return values

getMediaPlayed()

Return values

getMediaPlayed100Percent()

Return values

getMediaPlayed25Percent()

Return values

getMediaPlayed50Percent()

Return values

getMediaPlayed75Percent()

Return values

getModelName()

Return values

getSeq()

Return values

getters()

Return values

getUniqueMediaPlayed()

Return values

getUniqueMediaPlayed100Percent()

Return values

getUniqueMediaPlayed25Percent()

Return values

getUniqueMediaPlayed50Percent()

Return values

getUniqueMediaPlayed75Percent()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

GetMessageEventResponseMessage
in package

LINE

Clients

Insight

implements ModelInterface, ArrayAccess, JsonSerializable