LINE Messaging API SDK for PHP

ChannelAccessTokenApi

ChannelAccessTokenApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['getsAllValidChannelAccessTokenKeyIds' => ['application/json'], 'issueChannelToken' => ['application/x-www-form-urlencoded'], 'issueChannelTokenByJWT' => ['application/x-www-form-urlencoded'], 'issueStatelessChannelToken' => ['application/x-www-form-urlencoded'], 'revokeChannelToken' => ['application/x-www-form-urlencoded'], 'revokeChannelTokenByJWT' => ['application/x-www-form-urlencoded'], 'verifyChannelToken' => ['application/x-www-form-urlencoded'], 'verifyChannelTokenByJWT' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getsAllValidChannelAccessTokenKeyIds()  : ChannelAccessTokenKeyIdsResponse
Operation getsAllValidChannelAccessTokenKeyIds
getsAllValidChannelAccessTokenKeyIdsAsync()  : PromiseInterface
Operation getsAllValidChannelAccessTokenKeyIdsAsync
getsAllValidChannelAccessTokenKeyIdsAsyncWithHttpInfo()  : PromiseInterface
Operation getsAllValidChannelAccessTokenKeyIdsAsyncWithHttpInfo
getsAllValidChannelAccessTokenKeyIdsRequest()  : Request
Create request for operation 'getsAllValidChannelAccessTokenKeyIds'
getsAllValidChannelAccessTokenKeyIdsWithHttpInfo()  : array<string|int, mixed>
Operation getsAllValidChannelAccessTokenKeyIdsWithHttpInfo
issueChannelToken()  : IssueShortLivedChannelAccessTokenResponse|ErrorResponse
Operation issueChannelToken
issueChannelTokenAsync()  : PromiseInterface
Operation issueChannelTokenAsync
issueChannelTokenAsyncWithHttpInfo()  : PromiseInterface
Operation issueChannelTokenAsyncWithHttpInfo
issueChannelTokenByJWT()  : IssueChannelAccessTokenResponse
Operation issueChannelTokenByJWT
issueChannelTokenByJWTAsync()  : PromiseInterface
Operation issueChannelTokenByJWTAsync
issueChannelTokenByJWTAsyncWithHttpInfo()  : PromiseInterface
Operation issueChannelTokenByJWTAsyncWithHttpInfo
issueChannelTokenByJWTRequest()  : Request
Create request for operation 'issueChannelTokenByJWT'
issueChannelTokenByJWTWithHttpInfo()  : array<string|int, mixed>
Operation issueChannelTokenByJWTWithHttpInfo
issueChannelTokenRequest()  : Request
Create request for operation 'issueChannelToken'
issueChannelTokenWithHttpInfo()  : array<string|int, mixed>
Operation issueChannelTokenWithHttpInfo
issueStatelessChannelToken()  : IssueStatelessChannelAccessTokenResponse
Operation issueStatelessChannelToken
issueStatelessChannelTokenAsync()  : PromiseInterface
Operation issueStatelessChannelTokenAsync
issueStatelessChannelTokenAsyncWithHttpInfo()  : PromiseInterface
Operation issueStatelessChannelTokenAsyncWithHttpInfo
issueStatelessChannelTokenRequest()  : Request
Create request for operation 'issueStatelessChannelToken'
issueStatelessChannelTokenWithHttpInfo()  : array<string|int, mixed>
Operation issueStatelessChannelTokenWithHttpInfo
revokeChannelToken()  : void
Operation revokeChannelToken
revokeChannelTokenAsync()  : PromiseInterface
Operation revokeChannelTokenAsync
revokeChannelTokenAsyncWithHttpInfo()  : PromiseInterface
Operation revokeChannelTokenAsyncWithHttpInfo
revokeChannelTokenByJWT()  : void
Operation revokeChannelTokenByJWT
revokeChannelTokenByJWTAsync()  : PromiseInterface
Operation revokeChannelTokenByJWTAsync
revokeChannelTokenByJWTAsyncWithHttpInfo()  : PromiseInterface
Operation revokeChannelTokenByJWTAsyncWithHttpInfo
revokeChannelTokenByJWTRequest()  : Request
Create request for operation 'revokeChannelTokenByJWT'
revokeChannelTokenByJWTWithHttpInfo()  : array<string|int, mixed>
Operation revokeChannelTokenByJWTWithHttpInfo
revokeChannelTokenRequest()  : Request
Create request for operation 'revokeChannelToken'
revokeChannelTokenWithHttpInfo()  : array<string|int, mixed>
Operation revokeChannelTokenWithHttpInfo
setHostIndex()  : void
Set the host index
verifyChannelToken()  : VerifyChannelAccessTokenResponse
Operation verifyChannelToken
verifyChannelTokenAsync()  : PromiseInterface
Operation verifyChannelTokenAsync
verifyChannelTokenAsyncWithHttpInfo()  : PromiseInterface
Operation verifyChannelTokenAsyncWithHttpInfo
verifyChannelTokenByJWT()  : VerifyChannelAccessTokenResponse
Operation verifyChannelTokenByJWT
verifyChannelTokenByJWTAsync()  : PromiseInterface
Operation verifyChannelTokenByJWTAsync
verifyChannelTokenByJWTAsyncWithHttpInfo()  : PromiseInterface
Operation verifyChannelTokenByJWTAsyncWithHttpInfo
verifyChannelTokenByJWTRequest()  : Request
Create request for operation 'verifyChannelTokenByJWT'
verifyChannelTokenByJWTWithHttpInfo()  : array<string|int, mixed>
Operation verifyChannelTokenByJWTWithHttpInfo
verifyChannelTokenRequest()  : Request
Create request for operation 'verifyChannelToken'
verifyChannelTokenWithHttpInfo()  : array<string|int, mixed>
Operation verifyChannelTokenWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['getsAllValidChannelAccessTokenKeyIds' => ['application/json'], 'issueChannelToken' => ['application/x-www-form-urlencoded'], 'issueChannelTokenByJWT' => ['application/x-www-form-urlencoded'], 'issueStatelessChannelToken' => ['application/x-www-form-urlencoded'], 'revokeChannelToken' => ['application/x-www-form-urlencoded'], 'revokeChannelTokenByJWT' => ['application/x-www-form-urlencoded'], 'verifyChannelToken' => ['application/x-www-form-urlencoded'], 'verifyChannelTokenByJWT' => ['application/json']]

Properties

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

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

getsAllValidChannelAccessTokenKeyIds()

Operation getsAllValidChannelAccessTokenKeyIds

public getsAllValidChannelAccessTokenKeyIds(string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['getsAllValidChannelAccessTokenKeyIds'][0] ]) : ChannelAccessTokenKeyIdsResponse
Parameters
$clientAssertionType : string

`urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (required)

$clientAssertion : string

A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key. (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ChannelAccessTokenKeyIdsResponse

getsAllValidChannelAccessTokenKeyIdsAsync()

Operation getsAllValidChannelAccessTokenKeyIdsAsync

public getsAllValidChannelAccessTokenKeyIdsAsync(string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['getsAllValidChannelAccessTokenKeyIds'][0] ]) : PromiseInterface
Parameters
$clientAssertionType : string

`urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (required)

$clientAssertion : string

A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getsAllValidChannelAccessTokenKeyIdsAsyncWithHttpInfo()

Operation getsAllValidChannelAccessTokenKeyIdsAsyncWithHttpInfo

public getsAllValidChannelAccessTokenKeyIdsAsyncWithHttpInfo(string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['getsAllValidChannelAccessTokenKeyIds'][0] ]) : PromiseInterface
Parameters
$clientAssertionType : string

`urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (required)

$clientAssertion : string

A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getsAllValidChannelAccessTokenKeyIdsRequest()

Create request for operation 'getsAllValidChannelAccessTokenKeyIds'

public getsAllValidChannelAccessTokenKeyIdsRequest(string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['getsAllValidChannelAccessTokenKeyIds'][0] ]) : Request
Parameters
$clientAssertionType : string

`urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (required)

$clientAssertion : string

A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getsAllValidChannelAccessTokenKeyIdsWithHttpInfo()

Operation getsAllValidChannelAccessTokenKeyIdsWithHttpInfo

public getsAllValidChannelAccessTokenKeyIdsWithHttpInfo(string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['getsAllValidChannelAccessTokenKeyIds'][0] ]) : array<string|int, mixed>
Parameters
$clientAssertionType : string

`urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (required)

$clientAssertion : string

A JSON Web Token (JWT) (opens new window)the client needs to create and sign with the private key. (required)

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

The value for the Content-Type header. Check self::contentTypes['getsAllValidChannelAccessTokenKeyIds'] 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\ChannelAccessToken\Model\ChannelAccessTokenKeyIdsResponse, HTTP status code, HTTP response headers (array of strings)

issueChannelToken()

Operation issueChannelToken

public issueChannelToken(string $grantType, string $clientId, string $clientSecret[, string $contentType = self::contentTypes['issueChannelToken'][0] ]) : IssueShortLivedChannelAccessTokenResponse|ErrorResponse
Parameters
$grantType : string

`client_credentials` (required)

$clientId : string

Channel ID. (required)

$clientSecret : string

Channel secret. (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
IssueShortLivedChannelAccessTokenResponse|ErrorResponse

issueChannelTokenAsync()

Operation issueChannelTokenAsync

public issueChannelTokenAsync(string $grantType, string $clientId, string $clientSecret[, string $contentType = self::contentTypes['issueChannelToken'][0] ]) : PromiseInterface
Parameters
$grantType : string

`client_credentials` (required)

$clientId : string

Channel ID. (required)

$clientSecret : string

Channel secret. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueChannelTokenAsyncWithHttpInfo()

Operation issueChannelTokenAsyncWithHttpInfo

public issueChannelTokenAsyncWithHttpInfo(string $grantType, string $clientId, string $clientSecret[, string $contentType = self::contentTypes['issueChannelToken'][0] ]) : PromiseInterface
Parameters
$grantType : string

`client_credentials` (required)

$clientId : string

Channel ID. (required)

$clientSecret : string

Channel secret. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueChannelTokenByJWT()

Operation issueChannelTokenByJWT

public issueChannelTokenByJWT(string $grantType, string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['issueChannelTokenByJWT'][0] ]) : IssueChannelAccessTokenResponse
Parameters
$grantType : string

client_credentials (required)

$clientAssertionType : string

urn:ietf:params:oauth:client-assertion-type:jwt-bearer (required)

$clientAssertion : string

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
IssueChannelAccessTokenResponse

issueChannelTokenByJWTAsync()

Operation issueChannelTokenByJWTAsync

public issueChannelTokenByJWTAsync(string $grantType, string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['issueChannelTokenByJWT'][0] ]) : PromiseInterface
Parameters
$grantType : string

client_credentials (required)

$clientAssertionType : string

urn:ietf:params:oauth:client-assertion-type:jwt-bearer (required)

$clientAssertion : string

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueChannelTokenByJWTAsyncWithHttpInfo()

Operation issueChannelTokenByJWTAsyncWithHttpInfo

public issueChannelTokenByJWTAsyncWithHttpInfo(string $grantType, string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['issueChannelTokenByJWT'][0] ]) : PromiseInterface
Parameters
$grantType : string

client_credentials (required)

$clientAssertionType : string

urn:ietf:params:oauth:client-assertion-type:jwt-bearer (required)

$clientAssertion : string

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueChannelTokenByJWTRequest()

Create request for operation 'issueChannelTokenByJWT'

public issueChannelTokenByJWTRequest(string $grantType, string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['issueChannelTokenByJWT'][0] ]) : Request
Parameters
$grantType : string

client_credentials (required)

$clientAssertionType : string

urn:ietf:params:oauth:client-assertion-type:jwt-bearer (required)

$clientAssertion : string

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

issueChannelTokenByJWTWithHttpInfo()

Operation issueChannelTokenByJWTWithHttpInfo

public issueChannelTokenByJWTWithHttpInfo(string $grantType, string $clientAssertionType, string $clientAssertion[, string $contentType = self::contentTypes['issueChannelTokenByJWT'][0] ]) : array<string|int, mixed>
Parameters
$grantType : string

client_credentials (required)

$clientAssertionType : string

urn:ietf:params:oauth:client-assertion-type:jwt-bearer (required)

$clientAssertion : string

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (required)

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

The value for the Content-Type header. Check self::contentTypes['issueChannelTokenByJWT'] 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\ChannelAccessToken\Model\IssueChannelAccessTokenResponse, HTTP status code, HTTP response headers (array of strings)

issueChannelTokenRequest()

Create request for operation 'issueChannelToken'

public issueChannelTokenRequest(string $grantType, string $clientId, string $clientSecret[, string $contentType = self::contentTypes['issueChannelToken'][0] ]) : Request
Parameters
$grantType : string

`client_credentials` (required)

$clientId : string

Channel ID. (required)

$clientSecret : string

Channel secret. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

issueChannelTokenWithHttpInfo()

Operation issueChannelTokenWithHttpInfo

public issueChannelTokenWithHttpInfo(string $grantType, string $clientId, string $clientSecret[, string $contentType = self::contentTypes['issueChannelToken'][0] ]) : array<string|int, mixed>
Parameters
$grantType : string

`client_credentials` (required)

$clientId : string

Channel ID. (required)

$clientSecret : string

Channel secret. (required)

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

The value for the Content-Type header. Check self::contentTypes['issueChannelToken'] 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\ChannelAccessToken\Model\IssueShortLivedChannelAccessTokenResponse|\LINE\Clients\ChannelAccessToken\Model\ErrorResponse, HTTP status code, HTTP response headers (array of strings)

issueStatelessChannelToken()

Operation issueStatelessChannelToken

public issueStatelessChannelToken([string $grantType = null ][, string $clientAssertionType = null ][, string $clientAssertion = null ][, string $clientId = null ][, string $clientSecret = null ][, string $contentType = self::contentTypes['issueStatelessChannelToken'][0] ]) : IssueStatelessChannelAccessTokenResponse
Parameters
$grantType : string = null

`client_credentials` (optional)

$clientAssertionType : string = null

URL-encoded value of `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (optional)

$clientAssertion : string = null

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (optional)

$clientId : string = null

Channel ID. (optional)

$clientSecret : string = null

Channel secret. (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
IssueStatelessChannelAccessTokenResponse

issueStatelessChannelTokenAsync()

Operation issueStatelessChannelTokenAsync

public issueStatelessChannelTokenAsync([string $grantType = null ][, string $clientAssertionType = null ][, string $clientAssertion = null ][, string $clientId = null ][, string $clientSecret = null ][, string $contentType = self::contentTypes['issueStatelessChannelToken'][0] ]) : PromiseInterface
Parameters
$grantType : string = null

`client_credentials` (optional)

$clientAssertionType : string = null

URL-encoded value of `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (optional)

$clientAssertion : string = null

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (optional)

$clientId : string = null

Channel ID. (optional)

$clientSecret : string = null

Channel secret. (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueStatelessChannelTokenAsyncWithHttpInfo()

Operation issueStatelessChannelTokenAsyncWithHttpInfo

public issueStatelessChannelTokenAsyncWithHttpInfo([string $grantType = null ][, string $clientAssertionType = null ][, string $clientAssertion = null ][, string $clientId = null ][, string $clientSecret = null ][, string $contentType = self::contentTypes['issueStatelessChannelToken'][0] ]) : PromiseInterface
Parameters
$grantType : string = null

`client_credentials` (optional)

$clientAssertionType : string = null

URL-encoded value of `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (optional)

$clientAssertion : string = null

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (optional)

$clientId : string = null

Channel ID. (optional)

$clientSecret : string = null

Channel secret. (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueStatelessChannelTokenRequest()

Create request for operation 'issueStatelessChannelToken'

public issueStatelessChannelTokenRequest([string $grantType = null ][, string $clientAssertionType = null ][, string $clientAssertion = null ][, string $clientId = null ][, string $clientSecret = null ][, string $contentType = self::contentTypes['issueStatelessChannelToken'][0] ]) : Request
Parameters
$grantType : string = null

`client_credentials` (optional)

$clientAssertionType : string = null

URL-encoded value of `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (optional)

$clientAssertion : string = null

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (optional)

$clientId : string = null

Channel ID. (optional)

$clientSecret : string = null

Channel secret. (optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

issueStatelessChannelTokenWithHttpInfo()

Operation issueStatelessChannelTokenWithHttpInfo

public issueStatelessChannelTokenWithHttpInfo([string $grantType = null ][, string $clientAssertionType = null ][, string $clientAssertion = null ][, string $clientId = null ][, string $clientSecret = null ][, string $contentType = self::contentTypes['issueStatelessChannelToken'][0] ]) : array<string|int, mixed>
Parameters
$grantType : string = null

`client_credentials` (optional)

$clientAssertionType : string = null

URL-encoded value of `urn:ietf:params:oauth:client-assertion-type:jwt-bearer` (optional)

$clientAssertion : string = null

A JSON Web Token the client needs to create and sign with the private key of the Assertion Signing Key. (optional)

$clientId : string = null

Channel ID. (optional)

$clientSecret : string = null

Channel secret. (optional)

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

The value for the Content-Type header. Check self::contentTypes['issueStatelessChannelToken'] 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\ChannelAccessToken\Model\IssueStatelessChannelAccessTokenResponse, HTTP status code, HTTP response headers (array of strings)

revokeChannelToken()

Operation revokeChannelToken

public revokeChannelToken(string $accessToken[, string $contentType = self::contentTypes['revokeChannelToken'][0] ]) : void
Parameters
$accessToken : string

Channel access token (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

revokeChannelTokenAsync()

Operation revokeChannelTokenAsync

public revokeChannelTokenAsync(string $accessToken[, string $contentType = self::contentTypes['revokeChannelToken'][0] ]) : PromiseInterface
Parameters
$accessToken : string

Channel access token (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

revokeChannelTokenAsyncWithHttpInfo()

Operation revokeChannelTokenAsyncWithHttpInfo

public revokeChannelTokenAsyncWithHttpInfo(string $accessToken[, string $contentType = self::contentTypes['revokeChannelToken'][0] ]) : PromiseInterface
Parameters
$accessToken : string

Channel access token (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

revokeChannelTokenByJWT()

Operation revokeChannelTokenByJWT

public revokeChannelTokenByJWT(string $clientId, string $clientSecret, string $accessToken[, string $contentType = self::contentTypes['revokeChannelTokenByJWT'][0] ]) : void
Parameters
$clientId : string

Channel ID (required)

$clientSecret : string

Channel Secret (required)

$accessToken : string

Channel access token (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

revokeChannelTokenByJWTAsync()

Operation revokeChannelTokenByJWTAsync

public revokeChannelTokenByJWTAsync(string $clientId, string $clientSecret, string $accessToken[, string $contentType = self::contentTypes['revokeChannelTokenByJWT'][0] ]) : PromiseInterface
Parameters
$clientId : string

Channel ID (required)

$clientSecret : string

Channel Secret (required)

$accessToken : string

Channel access token (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

revokeChannelTokenByJWTAsyncWithHttpInfo()

Operation revokeChannelTokenByJWTAsyncWithHttpInfo

public revokeChannelTokenByJWTAsyncWithHttpInfo(string $clientId, string $clientSecret, string $accessToken[, string $contentType = self::contentTypes['revokeChannelTokenByJWT'][0] ]) : PromiseInterface
Parameters
$clientId : string

Channel ID (required)

$clientSecret : string

Channel Secret (required)

$accessToken : string

Channel access token (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

revokeChannelTokenByJWTRequest()

Create request for operation 'revokeChannelTokenByJWT'

public revokeChannelTokenByJWTRequest(string $clientId, string $clientSecret, string $accessToken[, string $contentType = self::contentTypes['revokeChannelTokenByJWT'][0] ]) : Request
Parameters
$clientId : string

Channel ID (required)

$clientSecret : string

Channel Secret (required)

$accessToken : string

Channel access token (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

revokeChannelTokenByJWTWithHttpInfo()

Operation revokeChannelTokenByJWTWithHttpInfo

public revokeChannelTokenByJWTWithHttpInfo(string $clientId, string $clientSecret, string $accessToken[, string $contentType = self::contentTypes['revokeChannelTokenByJWT'][0] ]) : array<string|int, mixed>
Parameters
$clientId : string

Channel ID (required)

$clientSecret : string

Channel Secret (required)

$accessToken : string

Channel access token (required)

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

The value for the Content-Type header. Check self::contentTypes['revokeChannelTokenByJWT'] 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)

revokeChannelTokenRequest()

Create request for operation 'revokeChannelToken'

public revokeChannelTokenRequest(string $accessToken[, string $contentType = self::contentTypes['revokeChannelToken'][0] ]) : Request
Parameters
$accessToken : string

Channel access token (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

revokeChannelTokenWithHttpInfo()

Operation revokeChannelTokenWithHttpInfo

public revokeChannelTokenWithHttpInfo(string $accessToken[, string $contentType = self::contentTypes['revokeChannelToken'][0] ]) : array<string|int, mixed>
Parameters
$accessToken : string

Channel access token (required)

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

The value for the Content-Type header. Check self::contentTypes['revokeChannelToken'] 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)

setHostIndex()

Set the host index

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

Host index (required)

Return values
void

verifyChannelToken()

Operation verifyChannelToken

public verifyChannelToken(string $accessToken[, string $contentType = self::contentTypes['verifyChannelToken'][0] ]) : VerifyChannelAccessTokenResponse
Parameters
$accessToken : string

A short-lived or long-lived channel access token. (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
VerifyChannelAccessTokenResponse

verifyChannelTokenAsync()

Operation verifyChannelTokenAsync

public verifyChannelTokenAsync(string $accessToken[, string $contentType = self::contentTypes['verifyChannelToken'][0] ]) : PromiseInterface
Parameters
$accessToken : string

A short-lived or long-lived channel access token. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

verifyChannelTokenAsyncWithHttpInfo()

Operation verifyChannelTokenAsyncWithHttpInfo

public verifyChannelTokenAsyncWithHttpInfo(string $accessToken[, string $contentType = self::contentTypes['verifyChannelToken'][0] ]) : PromiseInterface
Parameters
$accessToken : string

A short-lived or long-lived channel access token. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

verifyChannelTokenByJWT()

Operation verifyChannelTokenByJWT

public verifyChannelTokenByJWT(string $accessToken[, string $contentType = self::contentTypes['verifyChannelTokenByJWT'][0] ]) : VerifyChannelAccessTokenResponse
Parameters
$accessToken : string

Channel access token with a user-specified expiration (Channel Access Token v2.1). (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
VerifyChannelAccessTokenResponse

verifyChannelTokenByJWTAsync()

Operation verifyChannelTokenByJWTAsync

public verifyChannelTokenByJWTAsync(string $accessToken[, string $contentType = self::contentTypes['verifyChannelTokenByJWT'][0] ]) : PromiseInterface
Parameters
$accessToken : string

Channel access token with a user-specified expiration (Channel Access Token v2.1). (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

verifyChannelTokenByJWTAsyncWithHttpInfo()

Operation verifyChannelTokenByJWTAsyncWithHttpInfo

public verifyChannelTokenByJWTAsyncWithHttpInfo(string $accessToken[, string $contentType = self::contentTypes['verifyChannelTokenByJWT'][0] ]) : PromiseInterface
Parameters
$accessToken : string

Channel access token with a user-specified expiration (Channel Access Token v2.1). (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

verifyChannelTokenByJWTRequest()

Create request for operation 'verifyChannelTokenByJWT'

public verifyChannelTokenByJWTRequest(string $accessToken[, string $contentType = self::contentTypes['verifyChannelTokenByJWT'][0] ]) : Request
Parameters
$accessToken : string

Channel access token with a user-specified expiration (Channel Access Token v2.1). (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

verifyChannelTokenByJWTWithHttpInfo()

Operation verifyChannelTokenByJWTWithHttpInfo

public verifyChannelTokenByJWTWithHttpInfo(string $accessToken[, string $contentType = self::contentTypes['verifyChannelTokenByJWT'][0] ]) : array<string|int, mixed>
Parameters
$accessToken : string

Channel access token with a user-specified expiration (Channel Access Token v2.1). (required)

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

The value for the Content-Type header. Check self::contentTypes['verifyChannelTokenByJWT'] 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\ChannelAccessToken\Model\VerifyChannelAccessTokenResponse, HTTP status code, HTTP response headers (array of strings)

verifyChannelTokenRequest()

Create request for operation 'verifyChannelToken'

public verifyChannelTokenRequest(string $accessToken[, string $contentType = self::contentTypes['verifyChannelToken'][0] ]) : Request
Parameters
$accessToken : string

A short-lived or long-lived channel access token. (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

verifyChannelTokenWithHttpInfo()

Operation verifyChannelTokenWithHttpInfo

public verifyChannelTokenWithHttpInfo(string $accessToken[, string $contentType = self::contentTypes['verifyChannelToken'][0] ]) : array<string|int, mixed>
Parameters
$accessToken : string

A short-lived or long-lived channel access token. (required)

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

The value for the Content-Type header. Check self::contentTypes['verifyChannelToken'] 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\ChannelAccessToken\Model\VerifyChannelAccessTokenResponse, 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