LINE Messaging API SDK for PHP

BotInfoResponse
in package

LINE

Clients

MessagingApi

implements ModelInterface, ArrayAccess, JsonSerializable

BotInfoResponse Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

CHAT_MODE_BOT = 'bot'
CHAT_MODE_CHAT = 'chat'
DISCRIMINATOR = null
MARK_AS_READ_MODE_AUTO = 'auto'
MARK_AS_READ_MODE_MANUAL = 'manual'
$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
getBasicId() : string: Gets basicId
getChatMode() : string: Gets chatMode
getChatModeAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getDisplayName() : string: Gets displayName
getMarkAsReadMode() : string: Gets markAsReadMode
getMarkAsReadModeAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getModelName() : string: The original name of the model.
getPictureUrl() : string|null: Gets pictureUrl
getPremiumId() : string|null: Gets premiumId
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getUserId() : string: Gets userId
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
setBasicId() : self: Sets basicId
setChatMode() : self: Sets chatMode
setDisplayName() : self: Sets displayName
setMarkAsReadMode() : self: Sets markAsReadMode
setPictureUrl() : self: Sets pictureUrl
setPremiumId() : self: Sets premiumId
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setUserId() : self: Sets userId
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

CHAT_MODE_BOT


    public
        mixed
    CHAT_MODE_BOT
    = 'bot'

CHAT_MODE_CHAT


    public
        mixed
    CHAT_MODE_CHAT
    = 'chat'

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

MARK_AS_READ_MODE_AUTO


    public
        mixed
    MARK_AS_READ_MODE_AUTO
    = 'auto'

MARK_AS_READ_MODE_MANUAL


    public
        mixed
    MARK_AS_READ_MODE_MANUAL
    = 'manual'

$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
     = ['userId' => 'userId', 'basicId' => 'basicId', 'premiumId' => 'premiumId', 'displayName' => 'displayName', 'pictureUrl' => 'pictureUrl', 'chatMode' => 'chatMode', 'markAsReadMode' => 'markAsReadMode']

$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
     = ['userId' => 'getUserId', 'basicId' => 'getBasicId', 'premiumId' => 'getPremiumId', 'displayName' => 'getDisplayName', 'pictureUrl' => 'getPictureUrl', 'chatMode' => 'getChatMode', 'markAsReadMode' => 'getMarkAsReadMode']

$openAPIFormats

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


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['userId' => null, 'basicId' => null, 'premiumId' => null, 'displayName' => null, 'pictureUrl' => 'uri', 'chatMode' => null, 'markAsReadMode' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'BotInfoResponse'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['userId' => false, 'basicId' => false, 'premiumId' => false, 'displayName' => false, 'pictureUrl' => false, 'chatMode' => false, 'markAsReadMode' => 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
     = ['userId' => 'string', 'basicId' => 'string', 'premiumId' => 'string', 'displayName' => 'string', 'pictureUrl' => 'string', 'chatMode' => 'string', 'markAsReadMode' => 'string']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['userId' => 'setUserId', 'basicId' => 'setBasicId', 'premiumId' => 'setPremiumId', 'displayName' => 'setDisplayName', 'pictureUrl' => 'setPictureUrl', 'chatMode' => 'setChatMode', 'markAsReadMode' => 'setMarkAsReadMode']

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

getBasicId()

Gets basicId


    public
                    getBasicId() : string

Return values

string —

getChatMode()

Gets chatMode


    public
                    getChatMode() : string

Return values

string —

getChatModeAllowableValues()

Gets allowable values of the enum


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

Return values

array<string|int, string> —

getDisplayName()

Gets displayName


    public
                    getDisplayName() : string

Return values

string —

getMarkAsReadMode()

Gets markAsReadMode


    public
                    getMarkAsReadMode() : string

Return values

string —

getMarkAsReadModeAllowableValues()

Gets allowable values of the enum


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

Return values

array<string|int, string> —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getPictureUrl()

Gets pictureUrl


    public
                    getPictureUrl() : string|null

Return values

string|null —

getPremiumId()

Gets premiumId


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

getUserId()

Gets userId


    public
                    getUserId() : string

Return values

string —

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

setBasicId()

Sets basicId


    public
                    setBasicId(string $basicId) : self

Parameters

$basicId : string: Bot's basic ID

Return values

self —

setChatMode()

Sets chatMode


    public
                    setChatMode(string $chatMode) : self

Parameters

$chatMode : string: Chat settings set in the LINE Official Account Manager. One of: chat: Chat is set to "On". bot: Chat is set to "Off".

Return values

self —

setDisplayName()

Sets displayName


    public
                    setDisplayName(string $displayName) : self

Parameters

$displayName : string: Bot's display name

Return values

self —

setMarkAsReadMode()

Sets markAsReadMode


    public
                    setMarkAsReadMode(string $markAsReadMode) : self

Parameters

$markAsReadMode : string: Automatic read setting for messages. If the chat is set to "Off", auto is returned. If the chat is set to "On", manual is returned. auto: Auto read setting is enabled. manual: Auto read setting is disabled.

Return values

self —

setPictureUrl()

Sets pictureUrl


    public
                    setPictureUrl(string|null $pictureUrl) : self

Parameters

$pictureUrl : string|null: Profile image URL. https image URL. Not included in the response if the bot doesn't have a profile image.

Return values

self —

setPremiumId()

Sets premiumId


    public
                    setPremiumId(string|null $premiumId) : self

Parameters

$premiumId : string|null: Bot's premium ID. Not included in the response if the premium ID isn't set.

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

setUserId()

Sets userId


    public
                    setUserId(string $userId) : self

Parameters

$userId : string: Bot's user ID

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 —

BotInfoResponse in package LINE Clients MessagingApi implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

CHAT_MODE_BOT

CHAT_MODE_CHAT

DISCRIMINATOR

MARK_AS_READ_MODE_AUTO

MARK_AS_READ_MODE_MANUAL

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getBasicId()

Return values

getChatMode()

Return values

getChatModeAllowableValues()

Return values

getDisplayName()

Return values

getMarkAsReadMode()

Return values

getMarkAsReadModeAllowableValues()

Return values

getModelName()

Return values

getPictureUrl()

Return values

getPremiumId()

Return values

getters()

Return values

getUserId()

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

setBasicId()

Parameters

BotInfoResponse
in package

LINE

Clients

MessagingApi

implements ModelInterface, ArrayAccess, JsonSerializable