MessagingApiBlobApi
in package
MessagingApiBlobApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['getMessageContent' => ['application/json'], 'getMessageContentPreview' => ['application/json'], 'getMessageContentTranscodingByMessageId' => ['application/json'], 'getRichMenuImage' => ['application/json'], 'setRichMenuImage' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getMessageContent() : SplFileObject
- Operation getMessageContent
- getMessageContentAsync() : PromiseInterface
- Operation getMessageContentAsync
- getMessageContentAsyncWithHttpInfo() : PromiseInterface
- Operation getMessageContentAsyncWithHttpInfo
- getMessageContentPreview() : SplFileObject
- Operation getMessageContentPreview
- getMessageContentPreviewAsync() : PromiseInterface
- Operation getMessageContentPreviewAsync
- getMessageContentPreviewAsyncWithHttpInfo() : PromiseInterface
- Operation getMessageContentPreviewAsyncWithHttpInfo
- getMessageContentPreviewRequest() : Request
- Create request for operation 'getMessageContentPreview'
- getMessageContentPreviewWithHttpInfo() : array<string|int, mixed>
- Operation getMessageContentPreviewWithHttpInfo
- getMessageContentRequest() : Request
- Create request for operation 'getMessageContent'
- getMessageContentTranscodingByMessageId() : GetMessageContentTranscodingResponse
- Operation getMessageContentTranscodingByMessageId
- getMessageContentTranscodingByMessageIdAsync() : PromiseInterface
- Operation getMessageContentTranscodingByMessageIdAsync
- getMessageContentTranscodingByMessageIdAsyncWithHttpInfo() : PromiseInterface
- Operation getMessageContentTranscodingByMessageIdAsyncWithHttpInfo
- getMessageContentTranscodingByMessageIdRequest() : Request
- Create request for operation 'getMessageContentTranscodingByMessageId'
- getMessageContentTranscodingByMessageIdWithHttpInfo() : array<string|int, mixed>
- Operation getMessageContentTranscodingByMessageIdWithHttpInfo
- getMessageContentWithHttpInfo() : array<string|int, mixed>
- Operation getMessageContentWithHttpInfo
- getRichMenuImage() : SplFileObject
- Operation getRichMenuImage
- getRichMenuImageAsync() : PromiseInterface
- Operation getRichMenuImageAsync
- getRichMenuImageAsyncWithHttpInfo() : PromiseInterface
- Operation getRichMenuImageAsyncWithHttpInfo
- getRichMenuImageRequest() : Request
- Create request for operation 'getRichMenuImage'
- getRichMenuImageWithHttpInfo() : array<string|int, mixed>
- Operation getRichMenuImageWithHttpInfo
- setHostIndex() : void
- Set the host index
- setRichMenuImage() : void
- Operation setRichMenuImage
- setRichMenuImageAsync() : PromiseInterface
- Operation setRichMenuImageAsync
- setRichMenuImageAsyncWithHttpInfo() : PromiseInterface
- Operation setRichMenuImageAsyncWithHttpInfo
- setRichMenuImageRequest() : Request
- Create request for operation 'setRichMenuImage'
- setRichMenuImageWithHttpInfo() : array<string|int, mixed>
- Operation setRichMenuImageWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getHostSettingsForgetMessageContent() : array<string|int, mixed>
- Returns an array of host settings for Operation getMessageContent
- getHostSettingsForgetMessageContentPreview() : array<string|int, mixed>
- Returns an array of host settings for Operation getMessageContentPreview
- getHostSettingsForgetMessageContentTranscodingByMessageId() : array<string|int, mixed>
- Returns an array of host settings for Operation getMessageContentTranscodingByMessageId
- getHostSettingsForgetRichMenuImage() : array<string|int, mixed>
- Returns an array of host settings for Operation getRichMenuImage
- getHostSettingsForsetRichMenuImage() : array<string|int, mixed>
- Returns an array of host settings for Operation setRichMenuImage
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['getMessageContent' => ['application/json'], 'getMessageContentPreview' => ['application/json'], 'getMessageContentTranscodingByMessageId' => ['application/json'], 'getRichMenuImage' => ['application/json'], 'setRichMenuImage' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$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 —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getMessageContent()
Operation getMessageContent
public
getMessageContent(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContent'][0] ]) : SplFileObject
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContent'] to see the possible values for this operation
Tags
Return values
SplFileObject —getMessageContentAsync()
Operation getMessageContentAsync
public
getMessageContentAsync(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContent'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMessageContentAsyncWithHttpInfo()
Operation getMessageContentAsyncWithHttpInfo
public
getMessageContentAsyncWithHttpInfo(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContent'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMessageContentPreview()
Operation getMessageContentPreview
public
getMessageContentPreview(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentPreview'][0] ]) : SplFileObject
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of image or video (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentPreview'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentPreview'] to see the possible values for this operation
Tags
Return values
SplFileObject —getMessageContentPreviewAsync()
Operation getMessageContentPreviewAsync
public
getMessageContentPreviewAsync(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentPreview'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of image or video (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentPreview'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentPreview'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMessageContentPreviewAsyncWithHttpInfo()
Operation getMessageContentPreviewAsyncWithHttpInfo
public
getMessageContentPreviewAsyncWithHttpInfo(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentPreview'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of image or video (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentPreview'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentPreview'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMessageContentPreviewRequest()
Create request for operation 'getMessageContentPreview'
public
getMessageContentPreviewRequest(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentPreview'][0] ]) : Request
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of image or video (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentPreview'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentPreview'] to see the possible values for this operation
Tags
Return values
Request —getMessageContentPreviewWithHttpInfo()
Operation getMessageContentPreviewWithHttpInfo
public
getMessageContentPreviewWithHttpInfo(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentPreview'][0] ]) : array<string|int, mixed>
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of image or video (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentPreview'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentPreview'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getMessageContentRequest()
Create request for operation 'getMessageContent'
public
getMessageContentRequest(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContent'][0] ]) : Request
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContent'] to see the possible values for this operation
Tags
Return values
Request —getMessageContentTranscodingByMessageId()
Operation getMessageContentTranscodingByMessageId
public
getMessageContentTranscodingByMessageId(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentTranscodingByMessageId'][0] ]) : GetMessageContentTranscodingResponse
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentTranscodingByMessageId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentTranscodingByMessageId'] to see the possible values for this operation
Tags
Return values
GetMessageContentTranscodingResponse —getMessageContentTranscodingByMessageIdAsync()
Operation getMessageContentTranscodingByMessageIdAsync
public
getMessageContentTranscodingByMessageIdAsync(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentTranscodingByMessageId'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentTranscodingByMessageId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentTranscodingByMessageId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMessageContentTranscodingByMessageIdAsyncWithHttpInfo()
Operation getMessageContentTranscodingByMessageIdAsyncWithHttpInfo
public
getMessageContentTranscodingByMessageIdAsyncWithHttpInfo(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentTranscodingByMessageId'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentTranscodingByMessageId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentTranscodingByMessageId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMessageContentTranscodingByMessageIdRequest()
Create request for operation 'getMessageContentTranscodingByMessageId'
public
getMessageContentTranscodingByMessageIdRequest(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentTranscodingByMessageId'][0] ]) : Request
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentTranscodingByMessageId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentTranscodingByMessageId'] to see the possible values for this operation
Tags
Return values
Request —getMessageContentTranscodingByMessageIdWithHttpInfo()
Operation getMessageContentTranscodingByMessageIdWithHttpInfo
public
getMessageContentTranscodingByMessageIdWithHttpInfo(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContentTranscodingByMessageId'][0] ]) : array<string|int, mixed>
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContentTranscodingByMessageId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContentTranscodingByMessageId'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \LINE\Clients\MessagingApi\Model\GetMessageContentTranscodingResponse, HTTP status code, HTTP response headers (array of strings)
getMessageContentWithHttpInfo()
Operation getMessageContentWithHttpInfo
public
getMessageContentWithHttpInfo(string $messageId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getMessageContent'][0] ]) : array<string|int, mixed>
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $messageId : string
-
Message ID of video or audio (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getMessageContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMessageContent'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getRichMenuImage()
Operation getRichMenuImage
public
getRichMenuImage(string $richMenuId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getRichMenuImage'][0] ]) : SplFileObject
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
ID of the rich menu with the image to be downloaded (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRichMenuImage'] to see the possible values for this operation
Tags
Return values
SplFileObject —getRichMenuImageAsync()
Operation getRichMenuImageAsync
public
getRichMenuImageAsync(string $richMenuId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getRichMenuImage'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
ID of the rich menu with the image to be downloaded (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRichMenuImage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRichMenuImageAsyncWithHttpInfo()
Operation getRichMenuImageAsyncWithHttpInfo
public
getRichMenuImageAsyncWithHttpInfo(string $richMenuId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getRichMenuImage'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
ID of the rich menu with the image to be downloaded (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRichMenuImage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRichMenuImageRequest()
Create request for operation 'getRichMenuImage'
public
getRichMenuImageRequest(string $richMenuId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getRichMenuImage'][0] ]) : Request
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
ID of the rich menu with the image to be downloaded (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRichMenuImage'] to see the possible values for this operation
Tags
Return values
Request —getRichMenuImageWithHttpInfo()
Operation getRichMenuImageWithHttpInfo
public
getRichMenuImageWithHttpInfo(string $richMenuId[, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['getRichMenuImage'][0] ]) : array<string|int, mixed>
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
ID of the rich menu with the image to be downloaded (required)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['getRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRichMenuImage'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \SplFileObject, 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 —setRichMenuImage()
Operation setRichMenuImage
public
setRichMenuImage(string $richMenuId[, SplFileObject $body = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['setRichMenuImage'][0] ]) : void
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
The ID of the rich menu to attach the image to (required)
- $body : SplFileObject = null
-
body (optional)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['setRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['setRichMenuImage'] to see the possible values for this operation
Tags
Return values
void —setRichMenuImageAsync()
Operation setRichMenuImageAsync
public
setRichMenuImageAsync(string $richMenuId[, SplFileObject $body = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['setRichMenuImage'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
The ID of the rich menu to attach the image to (required)
- $body : SplFileObject = null
-
(optional)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['setRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['setRichMenuImage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —setRichMenuImageAsyncWithHttpInfo()
Operation setRichMenuImageAsyncWithHttpInfo
public
setRichMenuImageAsyncWithHttpInfo(string $richMenuId[, SplFileObject $body = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['setRichMenuImage'][0] ]) : PromiseInterface
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
The ID of the rich menu to attach the image to (required)
- $body : SplFileObject = null
-
(optional)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['setRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['setRichMenuImage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —setRichMenuImageRequest()
Create request for operation 'setRichMenuImage'
public
setRichMenuImageRequest(string $richMenuId[, SplFileObject $body = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['setRichMenuImage'][0] ]) : Request
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
The ID of the rich menu to attach the image to (required)
- $body : SplFileObject = null
-
(optional)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['setRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['setRichMenuImage'] to see the possible values for this operation
Tags
Return values
Request —setRichMenuImageWithHttpInfo()
Operation setRichMenuImageWithHttpInfo
public
setRichMenuImageWithHttpInfo(string $richMenuId[, SplFileObject $body = null ][, null|int $hostIndex = null ][, array<string|int, mixed> $variables = [] ][, string $contentType = self::contentTypes['setRichMenuImage'][0] ]) : array<string|int, mixed>
This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host. if needed, use the 'variables' parameter to pass variables to the host. URL: https://api-data.line.me
Parameters
- $richMenuId : string
-
The ID of the rich menu to attach the image to (required)
- $body : SplFileObject = null
-
(optional)
- $hostIndex : null|int = null
-
Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
- $variables : array<string|int, mixed> = []
-
Associative array of variables to pass to the host. Defaults to empty array.
- $contentType : string = self::contentTypes['setRichMenuImage'][0]
-
The value for the Content-Type header. Check self::contentTypes['setRichMenuImage'] to see the possible values for this operation
Tags
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
Return values
array<string|int, mixed> —of http client options
getHostSettingsForgetMessageContent()
Returns an array of host settings for Operation getMessageContent
protected
getHostSettingsForgetMessageContent() : array<string|int, mixed>
Return values
array<string|int, mixed> —an array of host settings
getHostSettingsForgetMessageContentPreview()
Returns an array of host settings for Operation getMessageContentPreview
protected
getHostSettingsForgetMessageContentPreview() : array<string|int, mixed>
Return values
array<string|int, mixed> —an array of host settings
getHostSettingsForgetMessageContentTranscodingByMessageId()
Returns an array of host settings for Operation getMessageContentTranscodingByMessageId
protected
getHostSettingsForgetMessageContentTranscodingByMessageId() : array<string|int, mixed>
Return values
array<string|int, mixed> —an array of host settings
getHostSettingsForgetRichMenuImage()
Returns an array of host settings for Operation getRichMenuImage
protected
getHostSettingsForgetRichMenuImage() : array<string|int, mixed>
Return values
array<string|int, mixed> —an array of host settings
getHostSettingsForsetRichMenuImage()
Returns an array of host settings for Operation setRichMenuImage
protected
getHostSettingsForsetRichMenuImage() : array<string|int, mixed>
Return values
array<string|int, mixed> —an array of host settings