Package com.linecorp.bot.client

Class LineMessagingClientImpl

java.lang.Object

com.linecorp.bot.client.LineMessagingClientImpl

All Implemented Interfaces:

LineMessagingClient

public class LineMessagingClientImpl
extends Object
implements LineMessagingClient

Proxy implementation of LineMessagingClient to hind internal implementation.

Constructor Summary

Constructors

Constructor	Description
LineMessagingClientImpl(com.linecorp.bot.client.LineMessagingService retrofitImpl, LineBlobClient blobDelegationTarget)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	broadcast(com.linecorp.bot.model.Broadcast broadcast)	Sends push messages to multiple users at any time.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	cancelDefaultRichMenu()	Cancel default rich menu.
CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse>	createRichMenu(com.linecorp.bot.model.richmenu.RichMenu richMenu)	Creates a rich menu.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	createRichMenuAlias(com.linecorp.bot.model.richmenualias.CreateRichMenuAliasRequest request)	Create a rich menu alias.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	deleteRichMenu(String richMenuId)	Deletes a rich menu.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	deleteRichMenuAlias(String richMenuAliasId)	Delete specified rich menu alias.
CompletableFuture<com.linecorp.bot.model.response.GetAggregationUnitNameListResponse>	getAggregationUnitNameList(String limit, String start)	Get name list of units used this month.
CompletableFuture<com.linecorp.bot.model.response.GetAggregationUnitUsageResponse>	getAggregationUnitUsage()	Get number of units used this month.
CompletableFuture<com.linecorp.bot.model.response.BotInfoResponse>	getBotInfo()	Gets a bot's basic information.
CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse>	getDefaultRichMenuId()	Get default rich menu ID.
CompletableFuture<com.linecorp.bot.model.response.GetFollowersResponse>	getFollowers(com.linecorp.bot.model.request.GetFollowersRequest request)	Get a list of users who added your LINE Official Account as a friend.
CompletableFuture<com.linecorp.bot.model.response.demographics.GetFriendsDemographicsResponse>	getFriendsDemographics()	Retrieves the demographic attributes for a bot's friends.
CompletableFuture<com.linecorp.bot.model.group.GroupMemberCountResponse>	getGroupMemberCount(String groupId)	Get members in group count.
CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse>	getGroupMemberProfile(String groupId, String userId)	Get group member profile.
CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse>	getGroupMembersIds(String groupId, String start)	Get (a part of) group member list.
CompletableFuture<com.linecorp.bot.model.group.GroupSummaryResponse>	getGroupSummary(String groupId)	Get group summary.
CompletableFuture<com.linecorp.bot.model.response.GetMessageEventResponse>	getMessageEvent(String requestId)	Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
CompletableFuture<com.linecorp.bot.model.response.MessageQuotaResponse>	getMessageQuota()	Gets the target limit for additional messages in the current month.
CompletableFuture<com.linecorp.bot.model.response.QuotaConsumptionResponse>	getMessageQuotaConsumption()	Gets the number of messages sent in the current month.
CompletableFuture<com.linecorp.bot.model.response.NarrowcastProgressResponse>	getNarrowcastProgress(String requestId)	Gets the status of a narrowcast message.
CompletableFuture<com.linecorp.bot.model.response.GetNumberOfFollowersResponse>	getNumberOfFollowers(String date)	Gets the number of users who have added the bot on or before a specified date.
CompletableFuture<com.linecorp.bot.model.response.GetNumberOfMessageDeliveriesResponse>	getNumberOfMessageDeliveries(String date)	Get number of message deliveries.
CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse>	getNumberOfSentBroadcastMessages(String date)	Gets the number of messages sent with the "/bot/message/broadcast" endpoint.
CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse>	getNumberOfSentMulticastMessages(String date)	Gets the number of messages sent with the /bot/message/multicast endpoint.
CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse>	getNumberOfSentPushMessages(String date)	Gets the number of messages sent with the /bot/message/push endpoint.
CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse>	getNumberOfSentReplyMessages(String date)	Gets the number of messages sent with the /bot/message/reply endpoint.
CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse>	getProfile(String userId)	Get user profile information.
CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuResponse>	getRichMenu(String richMenuId)	Get a rich menu.
CompletableFuture<com.linecorp.bot.model.richmenualias.RichMenuAliasResponse>	getRichMenuAlias(String richMenuAliasId)	Get specified rich menu alias.
CompletableFuture<com.linecorp.bot.model.richmenualias.RichMenuAliasListResponse>	getRichMenuAliasList()	Get rich menu alias list.
CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse>	getRichMenuIdOfUser(String userId)	Get rich menu ID of user.
CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuListResponse>	getRichMenuList()	Gets a list of all uploaded rich menus.
CompletableFuture<com.linecorp.bot.model.room.RoomMemberCountResponse>	getRoomMemberCount(String roomId)	Get members in room count.
CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse>	getRoomMemberProfile(String roomId, String userId)	Get room member profile.
CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse>	getRoomMembersIds(String roomId, String start)	Get (a part of) room member list.
CompletableFuture<com.linecorp.bot.model.response.GetStatisticsPerUnitResponse>	getStatisticsPerUnit(String customAggregationUnit, String from, String to)	Get statistics per aggregation unit.
CompletableFuture<com.linecorp.bot.model.response.GetWebhookEndpointResponse>	getWebhookEndpoint()	Gets webhook endpoint information.
CompletableFuture<com.linecorp.bot.model.response.IssueLinkTokenResponse>	issueLinkToken(String userId)	Issues a link token used for the account link feature.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	leaveGroup(String groupId)	Leave a group.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	leaveRoom(String roomId)	Leave a room.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	linkRichMenuIdToUser(String userId, String richMenuId)	Link rich menu to user.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	linkRichMenuIdToUsers(List<String> userIds, String richMenuId)	Link rich menu to users.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	multicast(com.linecorp.bot.model.Multicast multicast)	Send messages to multiple users at any time.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	narrowcast(com.linecorp.bot.model.Narrowcast narrowcast)	Sends a push message to multiple users.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	pushMessage(com.linecorp.bot.model.PushMessage pushMessage)	Send messages to users when you want to.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	replyMessage(com.linecorp.bot.model.ReplyMessage replyMessage)	Reply to messages from users.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	setDefaultRichMenu(String richMenuId)	Set default rich menu.
CompletableFuture<com.linecorp.bot.model.response.SetWebhookEndpointResponse>	setWebhookEndpoint(com.linecorp.bot.model.request.SetWebhookEndpointRequest request)	Sets webhook endpoint URL.
CompletableFuture<com.linecorp.bot.model.response.TestWebhookEndpointResponse>	testWebhookEndpoint(com.linecorp.bot.model.request.TestWebhookEndpointRequest request)	Tests webhook endpoint.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	unlinkRichMenuIdFromUser(String userId)	Unlink rich menu from user.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	unlinkRichMenuIdFromUsers(List<String> userIds)	Unlink rich menu from users.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	updateRichMenuAlias(String richMenuAliasId, com.linecorp.bot.model.richmenualias.UpdateRichMenuAliasRequest request)	Update the rich menu Id which associated with the rich menu alias.
CompletableFuture<com.linecorp.bot.model.response.BotApiResponse>	validateRichMenuObject(com.linecorp.bot.model.richmenu.RichMenu richMenu)	Validate a rich menu object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LineMessagingClientImpl

public LineMessagingClientImpl(com.linecorp.bot.client.LineMessagingService retrofitImpl,
 LineBlobClient blobDelegationTarget)

Method Details

replyMessage

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> replyMessage(com.linecorp.bot.model.ReplyMessage replyMessage)

Description copied from interface: LineMessagingClient

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.

Specified by:

replyMessage in interface LineMessagingClient

See Also:

• LineMessagingClient.pushMessage(PushMessage)
• //developers.line.me/en/reference/messaging-api/#send-reply-message

pushMessage

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> pushMessage(com.linecorp.bot.model.PushMessage pushMessage)

Description copied from interface: LineMessagingClient

Send messages to users when you want to.

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

Specified by:

pushMessage in interface LineMessagingClient

See Also:

• LineMessagingClient.replyMessage(ReplyMessage)
• //developers.line.me/en/reference/messaging-api/#send-push-message

multicast

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> multicast(com.linecorp.bot.model.Multicast multicast)

Description copied from interface: LineMessagingClient

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.

Specified by:

multicast in interface LineMessagingClient

See Also:

• LineMessagingClient.pushMessage(PushMessage)
• //developers.line.me/en/reference/messaging-api/#send-multicast-messages

broadcast

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> broadcast(com.linecorp.bot.model.Broadcast broadcast)

Description copied from interface: LineMessagingClient

Sends push messages to multiple users at any time. Note: LINE@ accounts cannot call this API endpoint. Please migrate it to a LINE official account. For more information, see Migration of LINE@ accounts.

Specified by:

broadcast in interface LineMessagingClient

narrowcast

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> narrowcast(com.linecorp.bot.model.Narrowcast narrowcast)

Description copied from interface: LineMessagingClient

Sends a push message to multiple users. You can specify recipients using attributes (such as age, gender, OS, and region) or by retargeting (audiences). Messages cannot be sent to groups or rooms.

Note: LINE-@ accounts cannot call this API endpoint. Please migrate it to a LINE official account. For more information, see Migration of LINE@ accounts.

Specified by:

narrowcast in interface LineMessagingClient

getNarrowcastProgress

public CompletableFuture<com.linecorp.bot.model.response.NarrowcastProgressResponse> getNarrowcastProgress(String requestId)

Gets the status of a narrowcast message.

Specified by:

getNarrowcastProgress in interface LineMessagingClient

getMessageQuota

public CompletableFuture<com.linecorp.bot.model.response.MessageQuotaResponse> getMessageQuota()

Description copied from interface: LineMessagingClient

Gets the target limit for additional messages in the current month. The number of messages retrieved by this operation includes the number of messages sent from LINE Official Account Manager. Set a target limit with LINE Official Account Manager. For the procedures, refer to the LINE Official Account Manager manual. Note: LINE@ accounts cannot call this API endpoint.

Specified by:

getMessageQuota in interface LineMessagingClient

getMessageQuotaConsumption

public CompletableFuture<com.linecorp.bot.model.response.QuotaConsumptionResponse> getMessageQuotaConsumption()

Description copied from interface: LineMessagingClient

Gets the number of messages sent in the current month. The number of messages retrieved by this operation includes the number of messages sent from LINE Official Account Manager. The number of messages retrieved by this operation is approximate. To get the correct number of sent messages, use LINE Official Account Manager or execute API operations for getting the number of sent messages. Note: LINE@ accounts cannot call this API endpoint.

Specified by:

getMessageQuotaConsumption in interface LineMessagingClient

getNumberOfSentReplyMessages

public CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse> getNumberOfSentReplyMessages(String date)

Description copied from interface: LineMessagingClient

Gets the number of messages sent with the /bot/message/reply endpoint. Note that the number of messages retrieved by this operation does not include the number of messages sent from LINE@ Manager.

Specified by:

getNumberOfSentReplyMessages in interface LineMessagingClient

Parameters:

date - Date the messages were sent. The format should be yyyyMMdd (for Example: "20191231") and the timezone should be UTC+9.

getNumberOfSentPushMessages

public CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse> getNumberOfSentPushMessages(String date)

Description copied from interface: LineMessagingClient

Gets the number of messages sent with the /bot/message/push endpoint. Note that the number of messages retrieved by this operation does not include the number of messages sent from LINE@ Manager.

Specified by:

getNumberOfSentPushMessages in interface LineMessagingClient

Parameters:

date - Date the messages were sent. The format should be yyyyMMdd (for Example: "20191231") and the timezone should be UTC+9.

getNumberOfSentMulticastMessages

public CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse> getNumberOfSentMulticastMessages(String date)

Description copied from interface: LineMessagingClient

Gets the number of messages sent with the /bot/message/multicast endpoint. The number of messages retrieved by this operation does not include the number of messages sent from LINE@ Manager.

Specified by:

getNumberOfSentMulticastMessages in interface LineMessagingClient

Parameters:

date - Date the messages were sent. The format should be yyyyMMdd (for Example: "20191231") and the timezone should be UTC+9.

getNumberOfSentBroadcastMessages

public CompletableFuture<com.linecorp.bot.model.response.NumberOfMessagesResponse> getNumberOfSentBroadcastMessages(String date)

Description copied from interface: LineMessagingClient

Gets the number of messages sent with the "/bot/message/broadcast" endpoint. The number of messages retrieved by this operation does not include the number of messages sent from LINE Official Account Manager. Note: LINE@ accounts cannot call this API endpoint. Please migrate it to a LINE official account. For more information, see Migration of LINE@ accounts.

Specified by:

getNumberOfSentBroadcastMessages in interface LineMessagingClient

Parameters:

date - Date the messages were sent. The format should be yyyyMMdd (for Example: "20191231") and the timezone should be UTC+9.

getProfile

public CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse> getProfile(String userId)

Description copied from interface: LineMessagingClient

Get user profile information.

Specified by:

getProfile in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#get-profile

getGroupMemberProfile

public CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse> getGroupMemberProfile(String groupId,
 String userId)

Description copied from interface: LineMessagingClient

Get group member profile.

Specified by:

getGroupMemberProfile in interface LineMessagingClient

Parameters:

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

userId - Identifier of the user.

See Also:

• //developers.line.me/en/reference/messaging-api/#get-group-member-profile

getRoomMemberProfile

public CompletableFuture<com.linecorp.bot.model.profile.UserProfileResponse> getRoomMemberProfile(String roomId,
 String userId)

Description copied from interface: LineMessagingClient

Get room member profile.

Specified by:

getRoomMemberProfile in interface LineMessagingClient

Parameters:

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

userId - Identifier of the user.

See Also:

• //developers.line.me/en/reference/messaging-api/#get-room-member-profile

getGroupMembersIds

public CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse> getGroupMembersIds(String groupId,
 String start)

Description copied from interface: LineMessagingClient

Get (a part of) group member list.

Specified by:

getGroupMembersIds in interface LineMessagingClient

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

See Also:

• //developers.line.me/en/reference/messaging-api/#get-group-member-user-ids
• MembersIdsResponse.getNext()

getRoomMembersIds

public CompletableFuture<com.linecorp.bot.model.profile.MembersIdsResponse> getRoomMembersIds(String roomId,
 String start)

Description copied from interface: LineMessagingClient

Get (a part of) room member list.

Specified by:

getRoomMembersIds in interface LineMessagingClient

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

See Also:

• //developers.line.me/en/reference/messaging-api/#get-room-member-user-ids
• MembersIdsResponse.getNext()

leaveGroup

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> leaveGroup(String groupId)

Description copied from interface: LineMessagingClient

Leave a group.

Specified by:

leaveGroup in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#leave-group

leaveRoom

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> leaveRoom(String roomId)

Description copied from interface: LineMessagingClient

Leave a room.

Specified by:

leaveRoom in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#leave-room

getGroupSummary

public CompletableFuture<com.linecorp.bot.model.group.GroupSummaryResponse> getGroupSummary(String groupId)

Description copied from interface: LineMessagingClient

Get group summary.

Specified by:

getGroupSummary in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#group

getGroupMemberCount

public CompletableFuture<com.linecorp.bot.model.group.GroupMemberCountResponse> getGroupMemberCount(String groupId)

Description copied from interface: LineMessagingClient

Get members in group count.

Specified by:

getGroupMemberCount in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#get-members-group-count

getRoomMemberCount

public CompletableFuture<com.linecorp.bot.model.room.RoomMemberCountResponse> getRoomMemberCount(String roomId)

Description copied from interface: LineMessagingClient

Get members in room count.

Specified by:

getRoomMemberCount in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#get-members-room-count

getRichMenu

public CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuResponse> getRichMenu(String richMenuId)

Description copied from interface: LineMessagingClient

Get a rich menu.

Specified by:

getRichMenu in interface LineMessagingClient

See Also:

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

validateRichMenuObject

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> validateRichMenuObject(com.linecorp.bot.model.richmenu.RichMenu richMenu)

Description copied from interface: LineMessagingClient

Validate a rich menu object.

You can verify that a rich menu object is valid as a request body for creating rich menu.

Specified by:

validateRichMenuObject in interface LineMessagingClient

See Also:

• //developers.line.me/en/docs/messaging-api/reference/#validate-rich-menu-object

createRichMenu

public CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse> createRichMenu(com.linecorp.bot.model.richmenu.RichMenu richMenu)

Description copied from interface: LineMessagingClient

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.

Specified by:

createRichMenu in interface LineMessagingClient

See Also:

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

deleteRichMenu

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> deleteRichMenu(String richMenuId)

Description copied from interface: LineMessagingClient

Deletes a rich menu.

Specified by:

deleteRichMenu in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#delete-rich-menu

getRichMenuIdOfUser

public CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse> getRichMenuIdOfUser(String userId)

Description copied from interface: LineMessagingClient

Get rich menu ID of user.

Specified by:

getRichMenuIdOfUser in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#get-rich-menu-id-of-user

linkRichMenuIdToUser

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> linkRichMenuIdToUser(String userId,
 String richMenuId)

Description copied from interface: LineMessagingClient

Link rich menu to user.

Specified by:

linkRichMenuIdToUser in interface LineMessagingClient

See Also:

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

linkRichMenuIdToUsers

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> linkRichMenuIdToUsers(List<String> userIds,
 String richMenuId)

Description copied from interface: LineMessagingClient

Link rich menu to users.

Specified by:

linkRichMenuIdToUsers in interface LineMessagingClient

See Also:

• Link rich menu to multiple users

unlinkRichMenuIdFromUser

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> unlinkRichMenuIdFromUser(String userId)

Description copied from interface: LineMessagingClient

Unlink rich menu from user.

Specified by:

unlinkRichMenuIdFromUser in interface LineMessagingClient

See Also:

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

unlinkRichMenuIdFromUsers

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> unlinkRichMenuIdFromUsers(List<String> userIds)

Description copied from interface: LineMessagingClient

Unlink rich menu from users.

Specified by:

unlinkRichMenuIdFromUsers in interface LineMessagingClient

See Also:

• Unlink rich menu to multiple users

getRichMenuList

public CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuListResponse> getRichMenuList()

Description copied from interface: LineMessagingClient

Gets a list of all uploaded rich menus.

Specified by:

getRichMenuList in interface LineMessagingClient

See Also:

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

setDefaultRichMenu

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> setDefaultRichMenu(String richMenuId)

Description copied from interface: LineMessagingClient

Set default rich menu.

Specified by:

setDefaultRichMenu in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#set-default-rich-menu

getDefaultRichMenuId

public CompletableFuture<com.linecorp.bot.model.richmenu.RichMenuIdResponse> getDefaultRichMenuId()

Description copied from interface: LineMessagingClient

Get default rich menu ID.

Specified by:

getDefaultRichMenuId in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#get-default-rich-menu-id

cancelDefaultRichMenu

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> cancelDefaultRichMenu()

Description copied from interface: LineMessagingClient

Cancel default rich menu.

Specified by:

cancelDefaultRichMenu in interface LineMessagingClient

See Also:

• //developers.line.me/en/reference/messaging-api/#cancel-default-rich-menu

createRichMenuAlias

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> createRichMenuAlias(com.linecorp.bot.model.richmenualias.CreateRichMenuAliasRequest request)

Description copied from interface: LineMessagingClient

Create a rich menu alias.

Specified by:

createRichMenuAlias in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias

updateRichMenuAlias

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> updateRichMenuAlias(String richMenuAliasId,
 com.linecorp.bot.model.richmenualias.UpdateRichMenuAliasRequest request)

Description copied from interface: LineMessagingClient

Update the rich menu Id which associated with the rich menu alias.

Specified by:

updateRichMenuAlias in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#update-rich-menu-alias

getRichMenuAlias

public CompletableFuture<com.linecorp.bot.model.richmenualias.RichMenuAliasResponse> getRichMenuAlias(String richMenuAliasId)

Description copied from interface: LineMessagingClient

Get specified rich menu alias.

Specified by:

getRichMenuAlias in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-by-id

getRichMenuAliasList

public CompletableFuture<com.linecorp.bot.model.richmenualias.RichMenuAliasListResponse> getRichMenuAliasList()

Description copied from interface: LineMessagingClient

Get rich menu alias list.

Specified by:

getRichMenuAliasList in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-list

deleteRichMenuAlias

public CompletableFuture<com.linecorp.bot.model.response.BotApiResponse> deleteRichMenuAlias(String richMenuAliasId)

Description copied from interface: LineMessagingClient

Delete specified rich menu alias.

Specified by:

deleteRichMenuAlias in interface LineMessagingClient

See Also:

• //developers.line.biz/en/reference/messaging-api/#delete-rich-menu-alias

issueLinkToken

public CompletableFuture<com.linecorp.bot.model.response.IssueLinkTokenResponse> issueLinkToken(String userId)

Description copied from interface: LineMessagingClient

Issues a link token used for the account link feature.

Specified by:

issueLinkToken in interface LineMessagingClient

See Also:

• Issue link token

getFriendsDemographics

public CompletableFuture<com.linecorp.bot.model.response.demographics.GetFriendsDemographicsResponse> getFriendsDemographics()

Description copied from interface: LineMessagingClient

Retrieves the demographic attributes for a bot's friends.

Specified by:

getFriendsDemographics in interface LineMessagingClient

See Also:

• Get friends demographics

getNumberOfMessageDeliveries

public CompletableFuture<com.linecorp.bot.model.response.GetNumberOfMessageDeliveriesResponse> getNumberOfMessageDeliveries(String date)

Description copied from interface: LineMessagingClient

Get number of message deliveries.

Specified by:

getNumberOfMessageDeliveries in interface LineMessagingClient

See Also:

• LineMessagingService.getNumberOfMessageDeliveries(String)

getNumberOfFollowers

public CompletableFuture<com.linecorp.bot.model.response.GetNumberOfFollowersResponse> getNumberOfFollowers(String date)

Description copied from interface: LineMessagingClient

Gets the number of users who have added the bot on or before a specified date.

Specified by:

getNumberOfFollowers in interface LineMessagingClient

getFollowers

public CompletableFuture<com.linecorp.bot.model.response.GetFollowersResponse> getFollowers(com.linecorp.bot.model.request.GetFollowersRequest request)

Description copied from interface: LineMessagingClient

Get a list of users who added your LINE Official Account as a friend.

Specified by:

getFollowers in interface LineMessagingClient

getMessageEvent

public CompletableFuture<com.linecorp.bot.model.response.GetMessageEventResponse> getMessageEvent(String requestId)

Description copied from interface: LineMessagingClient

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.

You can get statistics per message or per bubble.

Specified by:

getMessageEvent in interface LineMessagingClient

Parameters:

requestId - Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID. Find it in the response headers.

getBotInfo

public CompletableFuture<com.linecorp.bot.model.response.BotInfoResponse> getBotInfo()

Description copied from interface: LineMessagingClient

Gets a bot's basic information.

Specified by:

getBotInfo in interface LineMessagingClient

See Also:

• Get bot info

getWebhookEndpoint

public CompletableFuture<com.linecorp.bot.model.response.GetWebhookEndpointResponse> getWebhookEndpoint()

Description copied from interface: LineMessagingClient

Gets webhook endpoint information.

Specified by:

getWebhookEndpoint in interface LineMessagingClient

See Also:

• Get webhook endpoint information

setWebhookEndpoint

public CompletableFuture<com.linecorp.bot.model.response.SetWebhookEndpointResponse> setWebhookEndpoint(com.linecorp.bot.model.request.SetWebhookEndpointRequest request)

Description copied from interface: LineMessagingClient

Sets webhook endpoint URL.

Specified by:

setWebhookEndpoint in interface LineMessagingClient

See Also:

• Set webhook URL

testWebhookEndpoint

public CompletableFuture<com.linecorp.bot.model.response.TestWebhookEndpointResponse> testWebhookEndpoint(com.linecorp.bot.model.request.TestWebhookEndpointRequest request)

Description copied from interface: LineMessagingClient

Tests webhook endpoint.

Specified by:

testWebhookEndpoint in interface LineMessagingClient

See Also:

• Test webhook endpoint

getStatisticsPerUnit

public CompletableFuture<com.linecorp.bot.model.response.GetStatisticsPerUnitResponse> getStatisticsPerUnit(String customAggregationUnit,
 String from,
 String to)

Description copied from interface: LineMessagingClient

Get statistics per aggregation unit.

The API can only be used by corporate users who have submitted the required applications.

Specified by:

getStatisticsPerUnit in interface LineMessagingClient

See Also:

• Get statistics per unit

getAggregationUnitUsage

public CompletableFuture<com.linecorp.bot.model.response.GetAggregationUnitUsageResponse> getAggregationUnitUsage()

Description copied from interface: LineMessagingClient

Get number of units used this month.

The API can only be used by corporate users who have submitted the required applications.

Specified by:

getAggregationUnitUsage in interface LineMessagingClient

See Also:

• Get number of units used this month

getAggregationUnitNameList

public CompletableFuture<com.linecorp.bot.model.response.GetAggregationUnitNameListResponse> getAggregationUnitNameList(String limit,
 String start)

Description copied from interface: LineMessagingClient

Get name list of units used this month.

The API can only be used by corporate users who have submitted the required applications.

Specified by:

getAggregationUnitNameList in interface LineMessagingClient

See Also:

• Get name list of units used this month