LINE Messaging API SDK for PHP

GetNumberOfMessageDeliveriesResponse
in package

LINE

Clients

Insight

implements ModelInterface, ArrayAccess, JsonSerializable

GetNumberOfMessageDeliveriesResponse Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR = null
STATUS_OUT_OF_SERVICE = 'out_of_service'
STATUS_READY = 'ready'
STATUS_UNREADY = 'unready'

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
getApiBroadcast() : int|null: Gets apiBroadcast
getApiMulticast() : int|null: Gets apiMulticast
getApiNarrowcast() : int|null: Gets apiNarrowcast
getApiPush() : int|null: Gets apiPush
getApiReply() : int|null: Gets apiReply
getAutoResponse() : int|null: Gets autoResponse
getBroadcast() : int|null: Gets broadcast
getChat() : int|null: Gets chat
getModelName() : string: The original name of the model.
getStatus() : string|null: Gets status
getStatusAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getTargeting() : int|null: Gets targeting
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getWelcomeResponse() : int|null: Gets welcomeResponse
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
setApiBroadcast() : self: Sets apiBroadcast
setApiMulticast() : self: Sets apiMulticast
setApiNarrowcast() : self: Sets apiNarrowcast
setApiPush() : self: Sets apiPush
setApiReply() : self: Sets apiReply
setAutoResponse() : self: Sets autoResponse
setBroadcast() : self: Sets broadcast
setChat() : self: Sets chat
setStatus() : self: Sets status
setTargeting() : self: Sets targeting
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setWelcomeResponse() : self: Sets welcomeResponse
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

STATUS_OUT_OF_SERVICE


    public
        mixed
    STATUS_OUT_OF_SERVICE
    = 'out_of_service'

STATUS_READY


    public
        mixed
    STATUS_READY
    = 'ready'

STATUS_UNREADY


    public
        mixed
    STATUS_UNREADY
    = 'unready'

$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
     = ['status' => 'status', 'broadcast' => 'broadcast', 'targeting' => 'targeting', 'autoResponse' => 'autoResponse', 'welcomeResponse' => 'welcomeResponse', 'chat' => 'chat', 'apiBroadcast' => 'apiBroadcast', 'apiPush' => 'apiPush', 'apiMulticast' => 'apiMulticast', 'apiNarrowcast' => 'apiNarrowcast', 'apiReply' => 'apiReply']

$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
     = ['status' => 'getStatus', 'broadcast' => 'getBroadcast', 'targeting' => 'getTargeting', 'autoResponse' => 'getAutoResponse', 'welcomeResponse' => 'getWelcomeResponse', 'chat' => 'getChat', 'apiBroadcast' => 'getApiBroadcast', 'apiPush' => 'getApiPush', 'apiMulticast' => 'getApiMulticast', 'apiNarrowcast' => 'getApiNarrowcast', 'apiReply' => 'getApiReply']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['status' => null, 'broadcast' => 'int64', 'targeting' => 'int64', 'autoResponse' => 'int64', 'welcomeResponse' => 'int64', 'chat' => 'int64', 'apiBroadcast' => 'int64', 'apiPush' => 'int64', 'apiMulticast' => 'int64', 'apiNarrowcast' => 'int64', 'apiReply' => 'int64']

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'GetNumberOfMessageDeliveriesResponse'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['status' => false, 'broadcast' => false, 'targeting' => false, 'autoResponse' => false, 'welcomeResponse' => false, 'chat' => false, 'apiBroadcast' => false, 'apiPush' => false, 'apiMulticast' => false, 'apiNarrowcast' => false, 'apiReply' => false]

$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
     = ['status' => 'string', 'broadcast' => 'int', 'targeting' => 'int', 'autoResponse' => 'int', 'welcomeResponse' => 'int', 'chat' => 'int', 'apiBroadcast' => 'int', 'apiPush' => 'int', 'apiMulticast' => 'int', 'apiNarrowcast' => 'int', 'apiReply' => 'int']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['status' => 'setStatus', 'broadcast' => 'setBroadcast', 'targeting' => 'setTargeting', 'autoResponse' => 'setAutoResponse', 'welcomeResponse' => 'setWelcomeResponse', 'chat' => 'setChat', 'apiBroadcast' => 'setApiBroadcast', 'apiPush' => 'setApiPush', 'apiMulticast' => 'setApiMulticast', 'apiNarrowcast' => 'setApiNarrowcast', 'apiReply' => 'setApiReply']

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

getApiBroadcast()

Gets apiBroadcast


    public
                    getApiBroadcast() : int|null

Return values

int|null

getApiMulticast()

Gets apiMulticast


    public
                    getApiMulticast() : int|null

Return values

int|null

getApiNarrowcast()

Gets apiNarrowcast


    public
                    getApiNarrowcast() : int|null

Return values

int|null

getApiPush()

Gets apiPush


    public
                    getApiPush() : int|null

Return values

int|null

getApiReply()

Gets apiReply


    public
                    getApiReply() : int|null

Return values

int|null

getAutoResponse()

Gets autoResponse


    public
                    getAutoResponse() : int|null

Return values

int|null

getBroadcast()

Gets broadcast


    public
                    getBroadcast() : int|null

Return values

int|null

getChat()

Gets chat


    public
                    getChat() : int|null

Return values

int|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getStatus()

Gets status


    public
                    getStatus() : string|null

Return values

string|null

getStatusAllowableValues()

Gets allowable values of the enum


    public
                    getStatusAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getTargeting()

Gets targeting


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

getWelcomeResponse()

Gets welcomeResponse


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

setApiBroadcast()

Sets apiBroadcast


    public
                    setApiBroadcast(int|null $apiBroadcast) : self

Parameters

$apiBroadcast : int|null: Number of broadcast messages sent with the Send broadcast message Messaging API operation.

Return values

self

setApiMulticast()

Sets apiMulticast


    public
                    setApiMulticast(int|null $apiMulticast) : self

Parameters

$apiMulticast : int|null: Number of multicast messages sent with the Send multicast message Messaging API operation.

Return values

self

setApiNarrowcast()

Sets apiNarrowcast


    public
                    setApiNarrowcast(int|null $apiNarrowcast) : self

Parameters

$apiNarrowcast : int|null: Number of narrowcast messages sent with the Send narrowcast message Messaging API operation.

Return values

self

setApiPush()

Sets apiPush


    public
                    setApiPush(int|null $apiPush) : self

Parameters

$apiPush : int|null: Number of push messages sent with the Send push message Messaging API operation.

Return values

self

setApiReply()

Sets apiReply


    public
                    setApiReply(int|null $apiReply) : self

Parameters

$apiReply : int|null: Number of replies sent with the Send reply message Messaging API operation.

Return values

self

setAutoResponse()

Sets autoResponse


    public
                    setAutoResponse(int|null $autoResponse) : self

Parameters

$autoResponse : int|null: Number of auto-response messages sent.

Return values

self

setBroadcast()

Sets broadcast


    public
                    setBroadcast(int|null $broadcast) : self

Parameters

$broadcast : int|null: Number of messages sent to all of this LINE Official Account's friends (broadcast messages).

Return values

self

setChat()

Sets chat


    public
                    setChat(int|null $chat) : self

Parameters

$chat : int|null: Number of messages sent from LINE Official Account Manager Chat screen (only available in Japanese).

Return values

self

setStatus()

Sets status


    public
                    setStatus(string|null $status) : self

Parameters

$status : string|null: Status of the counting process.

Return values

self

setTargeting()

Sets targeting


    public
                    setTargeting(int|null $targeting) : self

Parameters

$targeting : int|null: Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages).

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>

setWelcomeResponse()

Sets welcomeResponse


    public
                    setWelcomeResponse(int|null $welcomeResponse) : self

Parameters

$welcomeResponse : int|null: Number of greeting messages sent.

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>

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

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

STATUS_OUT_OF_SERVICE

STATUS_READY

STATUS_UNREADY

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getApiBroadcast()

Return values

getApiMulticast()

Return values

getApiNarrowcast()

Return values

getApiPush()

Return values

getApiReply()

Return values

getAutoResponse()

Return values

getBroadcast()

Return values

getChat()

Return values

getModelName()

Return values

getStatus()

Return values

getStatusAllowableValues()

Return values

getTargeting()

Return values

getters()

Return values

getWelcomeResponse()

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()

GetNumberOfMessageDeliveriesResponse
in package

LINE

Clients

Insight

implements ModelInterface, ArrayAccess, JsonSerializable