LINE Messaging API SDK for PHP

LiffApi
in package

LiffApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['addLIFFApp' => ['application/json'], 'deleteLIFFApp' => ['application/json'], 'getAllLIFFApps' => ['application/json'], 'updateLIFFApp' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
addLIFFApp()  : AddLiffAppResponse
Operation addLIFFApp
addLIFFAppAsync()  : PromiseInterface
Operation addLIFFAppAsync
addLIFFAppAsyncWithHttpInfo()  : PromiseInterface
Operation addLIFFAppAsyncWithHttpInfo
addLIFFAppRequest()  : Request
Create request for operation 'addLIFFApp'
addLIFFAppWithHttpInfo()  : array<string|int, mixed>
Operation addLIFFAppWithHttpInfo
deleteLIFFApp()  : void
Operation deleteLIFFApp
deleteLIFFAppAsync()  : PromiseInterface
Operation deleteLIFFAppAsync
deleteLIFFAppAsyncWithHttpInfo()  : PromiseInterface
Operation deleteLIFFAppAsyncWithHttpInfo
deleteLIFFAppRequest()  : Request
Create request for operation 'deleteLIFFApp'
deleteLIFFAppWithHttpInfo()  : array<string|int, mixed>
Operation deleteLIFFAppWithHttpInfo
getAllLIFFApps()  : GetAllLiffAppsResponse
Operation getAllLIFFApps
getAllLIFFAppsAsync()  : PromiseInterface
Operation getAllLIFFAppsAsync
getAllLIFFAppsAsyncWithHttpInfo()  : PromiseInterface
Operation getAllLIFFAppsAsyncWithHttpInfo
getAllLIFFAppsRequest()  : Request
Create request for operation 'getAllLIFFApps'
getAllLIFFAppsWithHttpInfo()  : array<string|int, mixed>
Operation getAllLIFFAppsWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
setHostIndex()  : void
Set the host index
updateLIFFApp()  : void
Operation updateLIFFApp
updateLIFFAppAsync()  : PromiseInterface
Operation updateLIFFAppAsync
updateLIFFAppAsyncWithHttpInfo()  : PromiseInterface
Operation updateLIFFAppAsyncWithHttpInfo
updateLIFFAppRequest()  : Request
Create request for operation 'updateLIFFApp'
updateLIFFAppWithHttpInfo()  : array<string|int, mixed>
Operation updateLIFFAppWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['addLIFFApp' => ['application/json'], 'deleteLIFFApp' => ['application/json'], 'getAllLIFFApps' => ['application/json'], 'updateLIFFApp' => ['application/json']]

Properties

$client

protected ClientInterface $client

$hostIndex

protected int $hostIndex

Host index

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed

addLIFFApp()

Operation addLIFFApp

public addLIFFApp(AddLiffAppRequest $addLiffAppRequest[, string $contentType = self::contentTypes['addLIFFApp'][0] ]) : AddLiffAppResponse

Create LIFF app

Parameters
$addLiffAppRequest : AddLiffAppRequest

addLiffAppRequest (required)

$contentType : string = self::contentTypes['addLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['addLIFFApp'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AddLiffAppResponse

addLIFFAppAsync()

Operation addLIFFAppAsync

public addLIFFAppAsync(AddLiffAppRequest $addLiffAppRequest[, string $contentType = self::contentTypes['addLIFFApp'][0] ]) : PromiseInterface

Create LIFF app

Parameters
$addLiffAppRequest : AddLiffAppRequest

(required)

$contentType : string = self::contentTypes['addLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['addLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

addLIFFAppAsyncWithHttpInfo()

Operation addLIFFAppAsyncWithHttpInfo

public addLIFFAppAsyncWithHttpInfo(AddLiffAppRequest $addLiffAppRequest[, string $contentType = self::contentTypes['addLIFFApp'][0] ]) : PromiseInterface

Create LIFF app

Parameters
$addLiffAppRequest : AddLiffAppRequest

(required)

$contentType : string = self::contentTypes['addLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['addLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

addLIFFAppRequest()

Create request for operation 'addLIFFApp'

public addLIFFAppRequest(AddLiffAppRequest $addLiffAppRequest[, string $contentType = self::contentTypes['addLIFFApp'][0] ]) : Request
Parameters
$addLiffAppRequest : AddLiffAppRequest

(required)

$contentType : string = self::contentTypes['addLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['addLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

addLIFFAppWithHttpInfo()

Operation addLIFFAppWithHttpInfo

public addLIFFAppWithHttpInfo(AddLiffAppRequest $addLiffAppRequest[, string $contentType = self::contentTypes['addLIFFApp'][0] ]) : array<string|int, mixed>

Create LIFF app

Parameters
$addLiffAppRequest : AddLiffAppRequest

(required)

$contentType : string = self::contentTypes['addLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['addLIFFApp'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\Liff\Model\AddLiffAppResponse, HTTP status code, HTTP response headers (array of strings)

deleteLIFFApp()

Operation deleteLIFFApp

public deleteLIFFApp(string $liffId[, string $contentType = self::contentTypes['deleteLIFFApp'][0] ]) : void

Delete LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$contentType : string = self::contentTypes['deleteLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['deleteLIFFApp'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteLIFFAppAsync()

Operation deleteLIFFAppAsync

public deleteLIFFAppAsync(string $liffId[, string $contentType = self::contentTypes['deleteLIFFApp'][0] ]) : PromiseInterface

Delete LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$contentType : string = self::contentTypes['deleteLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['deleteLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteLIFFAppAsyncWithHttpInfo()

Operation deleteLIFFAppAsyncWithHttpInfo

public deleteLIFFAppAsyncWithHttpInfo(string $liffId[, string $contentType = self::contentTypes['deleteLIFFApp'][0] ]) : PromiseInterface

Delete LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$contentType : string = self::contentTypes['deleteLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['deleteLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteLIFFAppRequest()

Create request for operation 'deleteLIFFApp'

public deleteLIFFAppRequest(string $liffId[, string $contentType = self::contentTypes['deleteLIFFApp'][0] ]) : Request
Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$contentType : string = self::contentTypes['deleteLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['deleteLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteLIFFAppWithHttpInfo()

Operation deleteLIFFAppWithHttpInfo

public deleteLIFFAppWithHttpInfo(string $liffId[, string $contentType = self::contentTypes['deleteLIFFApp'][0] ]) : array<string|int, mixed>

Delete LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$contentType : string = self::contentTypes['deleteLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['deleteLIFFApp'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getAllLIFFApps()

Operation getAllLIFFApps

public getAllLIFFApps([string $contentType = self::contentTypes['getAllLIFFApps'][0] ]) : GetAllLiffAppsResponse

Get all LIFF apps

Parameters
$contentType : string = self::contentTypes['getAllLIFFApps'][0]

The value for the Content-Type header. Check self::contentTypes['getAllLIFFApps'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
GetAllLiffAppsResponse

getAllLIFFAppsAsync()

Operation getAllLIFFAppsAsync

public getAllLIFFAppsAsync([string $contentType = self::contentTypes['getAllLIFFApps'][0] ]) : PromiseInterface

Get all LIFF apps

Parameters
$contentType : string = self::contentTypes['getAllLIFFApps'][0]

The value for the Content-Type header. Check self::contentTypes['getAllLIFFApps'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllLIFFAppsAsyncWithHttpInfo()

Operation getAllLIFFAppsAsyncWithHttpInfo

public getAllLIFFAppsAsyncWithHttpInfo([string $contentType = self::contentTypes['getAllLIFFApps'][0] ]) : PromiseInterface

Get all LIFF apps

Parameters
$contentType : string = self::contentTypes['getAllLIFFApps'][0]

The value for the Content-Type header. Check self::contentTypes['getAllLIFFApps'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllLIFFAppsRequest()

Create request for operation 'getAllLIFFApps'

public getAllLIFFAppsRequest([string $contentType = self::contentTypes['getAllLIFFApps'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getAllLIFFApps'][0]

The value for the Content-Type header. Check self::contentTypes['getAllLIFFApps'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllLIFFAppsWithHttpInfo()

Operation getAllLIFFAppsWithHttpInfo

public getAllLIFFAppsWithHttpInfo([string $contentType = self::contentTypes['getAllLIFFApps'][0] ]) : array<string|int, mixed>

Get all LIFF apps

Parameters
$contentType : string = self::contentTypes['getAllLIFFApps'][0]

The value for the Content-Type header. Check self::contentTypes['getAllLIFFApps'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \LINE\Clients\Liff\Model\GetAllLiffAppsResponse, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void

updateLIFFApp()

Operation updateLIFFApp

public updateLIFFApp(string $liffId, UpdateLiffAppRequest $updateLiffAppRequest[, string $contentType = self::contentTypes['updateLIFFApp'][0] ]) : void

Update LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$updateLiffAppRequest : UpdateLiffAppRequest

updateLiffAppRequest (required)

$contentType : string = self::contentTypes['updateLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['updateLIFFApp'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

updateLIFFAppAsync()

Operation updateLIFFAppAsync

public updateLIFFAppAsync(string $liffId, UpdateLiffAppRequest $updateLiffAppRequest[, string $contentType = self::contentTypes['updateLIFFApp'][0] ]) : PromiseInterface

Update LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$updateLiffAppRequest : UpdateLiffAppRequest

(required)

$contentType : string = self::contentTypes['updateLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['updateLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateLIFFAppAsyncWithHttpInfo()

Operation updateLIFFAppAsyncWithHttpInfo

public updateLIFFAppAsyncWithHttpInfo(string $liffId, UpdateLiffAppRequest $updateLiffAppRequest[, string $contentType = self::contentTypes['updateLIFFApp'][0] ]) : PromiseInterface

Update LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$updateLiffAppRequest : UpdateLiffAppRequest

(required)

$contentType : string = self::contentTypes['updateLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['updateLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateLIFFAppRequest()

Create request for operation 'updateLIFFApp'

public updateLIFFAppRequest(string $liffId, UpdateLiffAppRequest $updateLiffAppRequest[, string $contentType = self::contentTypes['updateLIFFApp'][0] ]) : Request
Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$updateLiffAppRequest : UpdateLiffAppRequest

(required)

$contentType : string = self::contentTypes['updateLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['updateLIFFApp'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

updateLIFFAppWithHttpInfo()

Operation updateLIFFAppWithHttpInfo

public updateLIFFAppWithHttpInfo(string $liffId, UpdateLiffAppRequest $updateLiffAppRequest[, string $contentType = self::contentTypes['updateLIFFApp'][0] ]) : array<string|int, mixed>

Update LIFF app from a channel

Parameters
$liffId : string

ID of the LIFF app to be updated (required)

$updateLiffAppRequest : UpdateLiffAppRequest

(required)

$contentType : string = self::contentTypes['updateLIFFApp'][0]

The value for the Content-Type header. Check self::contentTypes['updateLIFFApp'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results