com.linecorp.bot.client

Interface LineMessagingClient

All Known Implementing Classes:

LineMessagingClientImpl

public interface LineMessagingClient

Method Summary

Modifier and Type	Method and Description
static LineMessagingClientBuilder	builder(ChannelTokenSupplier channelTokenSupplier)
static LineMessagingClientBuilder	builder(java.lang.String channelToken)
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse>	createRichMenu(com.linecorp.bot.model.richmenu.RichMenu richMenu) Creates a rich menu.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	deleteRichMenu(java.lang.String richMenuId) Deletes a rich menu.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse>	getGroupMemberProfile(java.lang.String groupId, java.lang.String userId) Get room member profile.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse>	getGroupMembersIds(java.lang.String groupId, java.lang.String start) Get (a part of) group member list.
java.util.concurrent.CompletableFuture<MessageContentResponse>	getMessageContent(java.lang.String messageId) Download image, video, and audio data sent from users.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse>	getProfile(java.lang.String userId) Get user profile information.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuResponse>	getRichMenu(java.lang.String richMenuId) Get a rich menu.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse>	getRichMenuIdOfUser(java.lang.String userId) Get rich menu ID of user.
java.util.concurrent.CompletableFuture<MessageContentResponse>	getRichMenuImage(java.lang.String richMenuId) Download rich menu image.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuListResponse>	getRichMenuList() Gets a list of all uploaded rich menus.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse>	getRoomMemberProfile(java.lang.String roomId, java.lang.String userId) Get group member profile.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse>	getRoomMembersIds(java.lang.String roomId, java.lang.String start) Get (a part of) room member list.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	leaveGroup(java.lang.String groupId) Leave a group.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	leaveRoom(java.lang.String roomId) Leave a room.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	linkRichMenuIdToUser(java.lang.String userId, java.lang.String richMenuId) Link rich menu to user.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	multicast(com.linecorp.bot.model.Multicast multicast) Send messages to multiple users at any time.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	pushMessage(com.linecorp.bot.model.PushMessage pushMessage) Send messages to users when you want to.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	replyMessage(com.linecorp.bot.model.ReplyMessage replyMessage) Reply to messages from users.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	setRichMenuImage(java.lang.String richMenuId, java.lang.String contentType, byte[] content) Set RichMenu image.
java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	unlinkRichMenuIdFromUser(java.lang.String userId) Unlink rich menu from user.

Method Detail

replyMessage

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> replyMessage(com.linecorp.bot.model.ReplyMessage replyMessage)

Reply to messages from users.

Webhooks are used to notify you when an event occurs. For events that you can respond to, a replyToken is issued for replying to messages.

Because the replyToken becomes invalid after a certain period of time, responses should be sent as soon as a message is received. Reply tokens can only be used once.

See Also:

pushMessage(PushMessage), //devdocs.line.me#reply-message

pushMessage

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> pushMessage(com.linecorp.bot.model.PushMessage pushMessage)

Send messages to users when you want to.

INFO: Use of the Push Message API is limited to certain plans.

See Also:

replyMessage(ReplyMessage), //devdocs.line.me#push-message

multicast

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> multicast(com.linecorp.bot.model.Multicast multicast)

Send messages to multiple users at any time. IDs of groups or rooms cannot be used.

INFO: Only available for plans which support push messages. Messages cannot be sent to groups or rooms.

INFO: Use IDs returned via the webhook event of source users. IDs of groups or rooms cannot be used. Do not use the LINE ID found on the LINE app.

See Also:

pushMessage(PushMessage), //devdocs.line.me#multicast

getMessageContent

java.util.concurrent.CompletableFuture<MessageContentResponse> getMessageContent(java.lang.String messageId)

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

See Also:

//devdocs.line.me#get-content

getProfile

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse> getProfile(java.lang.String userId)

Get user profile information.

See Also:

//devdocs.line.me#bot-api-get-profile

getGroupMemberProfile

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse> getGroupMemberProfile(java.lang.String groupId,
                                                                                                                 java.lang.String userId)

Get room member profile.

Parameters:

groupId - Identifier of the group. Can be get by GroupSource.getGroupId().

userId - Identifier of the user.

See Also:

//devdocs.line.me#get-group-room-member-profile

getRoomMemberProfile

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse> getRoomMemberProfile(java.lang.String roomId,
                                                                                                                java.lang.String userId)

Get group member profile.

Parameters:

roomId - Identifier of the group. Can be get by RoomSource.getRoomId().

userId - Identifier of the user.

See Also:

//devdocs.line.me#get-group-room-member-profile

getGroupMembersIds

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse> getGroupMembersIds(java.lang.String groupId,
                                                                                                             java.lang.String start)

Get (a part of) group member list.

Parameters:

start - nullable continuationToken which can be get MembersIdsResponse.getNext()

See Also:

MembersIdsResponse.getNext()

getRoomMembersIds

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse> getRoomMembersIds(java.lang.String roomId,
                                                                                                            java.lang.String start)

Get (a part of) room member list.

Parameters:

start - nullable continuationToken which can be get MembersIdsResponse.getNext()

See Also:

MembersIdsResponse.getNext()

leaveGroup

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> leaveGroup(java.lang.String groupId)

Leave a group.

See Also:

//devdocs.line.me#leave

leaveRoom

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> leaveRoom(java.lang.String roomId)

Leave a room.

See Also:

//devdocs.line.me#leave

getRichMenu

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuResponse> getRichMenu(java.lang.String richMenuId)

Get a rich menu.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#get-rich-menu

createRichMenu

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse> createRichMenu(com.linecorp.bot.model.richmenu.RichMenu richMenu)

Creates a rich menu.

Note: You must upload a rich menu image and link the rich menu to a user for the rich menu to be displayed. You can create up to 10 rich menus for one bot.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#create-rich-menu

deleteRichMenu

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> deleteRichMenu(java.lang.String richMenuId)

Deletes a rich menu.

getRichMenuIdOfUser

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse> getRichMenuIdOfUser(java.lang.String userId)

Get rich menu ID of user.

linkRichMenuIdToUser

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> linkRichMenuIdToUser(java.lang.String userId,
                                                                                                            java.lang.String richMenuId)

Link rich menu to user.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#link-rich-menu-to-user

unlinkRichMenuIdFromUser

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> unlinkRichMenuIdFromUser(java.lang.String userId)

Unlink rich menu from user.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#unlink-rich-menu-from-user

getRichMenuImage

java.util.concurrent.CompletableFuture<MessageContentResponse> getRichMenuImage(java.lang.String richMenuId)

Download rich menu image.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#download-rich-menu-image

setRichMenuImage

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> setRichMenuImage(java.lang.String richMenuId,
                                                                                                        java.lang.String contentType,
                                                                                                        byte[] content)

Set RichMenu image.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#upload-rich-menu-image

getRichMenuList

java.util.concurrent.CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuListResponse> getRichMenuList()

Gets a list of all uploaded rich menus.

See Also:

//developers.line.me/en/docs/messaging-api/reference/#get-rich-menu-list

builder

static LineMessagingClientBuilder builder(java.lang.String channelToken)

builder

static LineMessagingClientBuilder builder(ChannelTokenSupplier channelTokenSupplier)