@line/bot-sdk / Exports / messagingApi / MessagingApiBlobClient

Class: MessagingApiBlobClient

messagingApi.MessagingApiBlobClient

Table of contents

Constructors

• constructor

Methods

• getMessageContent
• getMessageContentPreview
• getMessageContentPreviewWithHttpInfo
• getMessageContentTranscodingByMessageId
• getMessageContentTranscodingByMessageIdWithHttpInfo
• getMessageContentWithHttpInfo
• getRichMenuImage
• getRichMenuImageWithHttpInfo
• setRichMenuImage
• setRichMenuImageWithHttpInfo

Constructors

constructor

• new MessagingApiBlobClient(config): MessagingApiBlobClient

Parameters

Name	Type
config	httpClientConfig

Returns

MessagingApiBlobClient

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:37

Methods

getMessageContent

▸ getMessageContent(messageId): Promise<Readable>

Download image, video, and audio data sent from users.

Parameters

Name	Type	Description
messageId	string	Message ID of video or audio

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:66

---

getMessageContentPreview

▸ getMessageContentPreview(messageId): Promise<Readable>

Get a preview image of the image or video

Parameters

Name	Type	Description
messageId	string	Message ID of image or video

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:97

---

getMessageContentPreviewWithHttpInfo

▸ getMessageContentPreviewWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Get a preview image of the image or video. This method includes HttpInfo object to return additional information.

Parameters

Name	Type	Description
messageId	string	Message ID of image or video

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:108

---

getMessageContentTranscodingByMessageId

▸ getMessageContentTranscodingByMessageId(messageId): Promise<GetMessageContentTranscodingResponse>

Verify the preparation status of a video or audio for getting

Parameters

Name	Type	Description
messageId	string	Message ID of video or audio

Returns

Promise<GetMessageContentTranscodingResponse>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:128

---

getMessageContentTranscodingByMessageIdWithHttpInfo

▸ getMessageContentTranscodingByMessageIdWithHttpInfo(messageId): Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

Verify the preparation status of a video or audio for getting. This method includes HttpInfo object to return additional information.

Parameters

Name	Type	Description
messageId	string	Message ID of video or audio

Returns

Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:143

---

getMessageContentWithHttpInfo

▸ getMessageContentWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Download image, video, and audio data sent from users.. This method includes HttpInfo object to return additional information.

Parameters

Name	Type	Description
messageId	string	Message ID of video or audio

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:77

---

getRichMenuImage

▸ getRichMenuImage(richMenuId): Promise<Readable>

Download rich menu image.

Parameters

Name	Type	Description
richMenuId	string	ID of the rich menu with the image to be downloaded

Returns

Promise<Readable>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:160

---

getRichMenuImageWithHttpInfo

▸ getRichMenuImageWithHttpInfo(richMenuId): Promise<ApiResponseType<Readable>>

Download rich menu image.. This method includes HttpInfo object to return additional information.

Parameters

Name	Type	Description
richMenuId	string	ID of the rich menu with the image to be downloaded

Returns

Promise<ApiResponseType<Readable>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:171

---

setRichMenuImage

▸ setRichMenuImage(richMenuId, body?): Promise<MessageAPIResponseBase>

Upload rich menu image

Parameters

Name	Type	Description
richMenuId	string	The ID of the rich menu to attach the image to
body?	Blob

Returns

Promise<MessageAPIResponseBase>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:192

---

setRichMenuImageWithHttpInfo

▸ setRichMenuImageWithHttpInfo(richMenuId, body?): Promise<ApiResponseType<MessageAPIResponseBase>>

Upload rich menu image. This method includes HttpInfo object to return additional information.

Parameters

Name	Type	Description
richMenuId	string	The ID of the rich menu to attach the image to
body?	Blob

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

Documentation

Defined in

lib/messaging-api/api/messagingApiBlobClient.ts:207