LINE Messaging API SDK for PHP

GetMessageEventResponseOverview
in package

LINE

Clients

Insight

implements ModelInterface, ArrayAccess, JsonSerializable

GetMessageEventResponseOverview 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
getDelivered() : int|null: Gets delivered
getModelName() : string: The original name of the model.
getRequestId() : string|null: Gets requestId
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTimestamp() : int|null: Gets timestamp
getUniqueClick() : int|null: Gets uniqueClick
getUniqueImpression() : int|null: Gets uniqueImpression
getUniqueMediaPlayed() : int|null: Gets uniqueMediaPlayed
getUniqueMediaPlayed100Percent() : int|null: Gets uniqueMediaPlayed100Percent
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
setDelivered() : self: Sets delivered
setRequestId() : self: Sets requestId
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTimestamp() : self: Sets timestamp
setUniqueClick() : self: Sets uniqueClick
setUniqueImpression() : self: Sets uniqueImpression
setUniqueMediaPlayed() : self: Sets uniqueMediaPlayed
setUniqueMediaPlayed100Percent() : self: Sets uniqueMediaPlayed100Percent
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
     = ['requestId' => 'requestId', 'timestamp' => 'timestamp', 'delivered' => 'delivered', 'uniqueImpression' => 'uniqueImpression', 'uniqueClick' => 'uniqueClick', 'uniqueMediaPlayed' => 'uniqueMediaPlayed', '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
     = ['requestId' => 'getRequestId', 'timestamp' => 'getTimestamp', 'delivered' => 'getDelivered', 'uniqueImpression' => 'getUniqueImpression', 'uniqueClick' => 'getUniqueClick', 'uniqueMediaPlayed' => 'getUniqueMediaPlayed', 'uniqueMediaPlayed100Percent' => 'getUniqueMediaPlayed100Percent']

$openAPIFormats

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


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['requestId' => null, 'timestamp' => 'int64', 'delivered' => 'int64', 'uniqueImpression' => 'int64', 'uniqueClick' => 'int64', 'uniqueMediaPlayed' => 'int64', 'uniqueMediaPlayed100Percent' => 'int64']

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'GetMessageEventResponseOverview'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['requestId' => false, 'timestamp' => false, 'delivered' => false, 'uniqueImpression' => true, 'uniqueClick' => true, 'uniqueMediaPlayed' => true, 'uniqueMediaPlayed100Percent' => true]

$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
     = ['requestId' => 'string', 'timestamp' => 'int', 'delivered' => 'int', 'uniqueImpression' => 'int', 'uniqueClick' => 'int', 'uniqueMediaPlayed' => 'int', 'uniqueMediaPlayed100Percent' => 'int']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['requestId' => 'setRequestId', 'timestamp' => 'setTimestamp', 'delivered' => 'setDelivered', 'uniqueImpression' => 'setUniqueImpression', 'uniqueClick' => 'setUniqueClick', 'uniqueMediaPlayed' => 'setUniqueMediaPlayed', 'uniqueMediaPlayed100Percent' => 'setUniqueMediaPlayed100Percent']

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

getDelivered()

Gets delivered


    public
                    getDelivered() : int|null

Return values

int|null —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getRequestId()

Gets requestId


    public
                    getRequestId() : string|null

Return values

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

getTimestamp()

Gets timestamp


    public
                    getTimestamp() : int|null

Return values

int|null —

getUniqueClick()

Gets uniqueClick


    public
                    getUniqueClick() : int|null

Return values

int|null —

getUniqueImpression()

Gets uniqueImpression


    public
                    getUniqueImpression() : int|null

Return values

int|null —

getUniqueMediaPlayed()

Gets uniqueMediaPlayed


    public
                    getUniqueMediaPlayed() : int|null

Return values

int|null —

getUniqueMediaPlayed100Percent()

Gets uniqueMediaPlayed100Percent


    public
                    getUniqueMediaPlayed100Percent() : 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

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

setDelivered()

Sets delivered


    public
                    setDelivered(int|null $delivered) : self

Parameters

$delivered : int|null: Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.

Return values

self —

setRequestId()

Sets requestId


    public
                    setRequestId(string|null $requestId) : self

Parameters

$requestId : string|null: Request ID.

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

setTimestamp()

Sets timestamp


    public
                    setTimestamp(int|null $timestamp) : self

Parameters

$timestamp : int|null: UNIX timestamp for message delivery time in seconds.

Return values

self —

setUniqueClick()

Sets uniqueClick


    public
                    setUniqueClick(int|null $uniqueClick) : self

Parameters

$uniqueClick : int|null: Number of users who opened any URL in the message.

Return values

self —

setUniqueImpression()

Sets uniqueImpression


    public
                    setUniqueImpression(int|null $uniqueImpression) : self

Parameters

$uniqueImpression : int|null: Number of users who opened the message, meaning they displayed at least 1 bubble.

Return values

self —

setUniqueMediaPlayed()

Sets uniqueMediaPlayed


    public
                    setUniqueMediaPlayed(int|null $uniqueMediaPlayed) : self

Parameters

$uniqueMediaPlayed : int|null: Number of users who started playing any video or audio in the message.

Return values

self —

setUniqueMediaPlayed100Percent()

Sets uniqueMediaPlayed100Percent


    public
                    setUniqueMediaPlayed100Percent(int|null $uniqueMediaPlayed100Percent) : self

Parameters

$uniqueMediaPlayed100Percent : int|null: Number of users who played the entirety of any video or audio in the message.

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>

Return values

void —

GetMessageEventResponseOverview in package LINE Clients Insight 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

getDelivered()

Return values

getModelName()

Return values

getRequestId()

Return values

getters()

Return values

getTimestamp()

Return values

getUniqueClick()

Return values

getUniqueImpression()

Return values

getUniqueMediaPlayed()

Return values

getUniqueMediaPlayed100Percent()

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

setDelivered()

Parameters

Return values

setRequestId()

Parameters

Return values

setters()

Return values

setTimestamp()

Parameters

GetMessageEventResponseOverview
in package

LINE

Clients

Insight

implements ModelInterface, ArrayAccess, JsonSerializable