com.linecorp.linesdk.api

Interface LineApiClient

All Known Implementing Classes:

LineApiClientImpl

public interface LineApiClient

An API client that provides you with access to the LINE Social API to perform operations such as getting the current access token, getting the user profile, logging out the user, refreshing the access token, and verifying the access token.

Method Summary

Modifier and Type	Method and Description
LineApiResponse<LineAccessToken>	getCurrentAccessToken() Gets the access token that the SDK is using for the user.
LineApiResponse<GetFriendsResponse>	getFriends(FriendSortField sortField, java.lang.String nextPageRequestToken)
LineApiResponse<GetFriendsResponse>	getFriends(FriendSortField sortField, java.lang.String nextPageRequestToken, boolean isForOttShareMessage)
LineApiResponse<GetFriendsResponse>	getFriendsApprovers(FriendSortField sortField, java.lang.String nextPageRequestToken)
LineApiResponse<LineFriendshipStatus>	getFriendshipStatus() Gets the friendship status between the bot (which is linked to the current channel) and the user.
LineApiResponse<GetFriendsResponse>	getGroupApprovers(java.lang.String groupId, java.lang.String nextPageRequestToken)
LineApiResponse<GetGroupsResponse>	getGroups(java.lang.String nextPageRequestToken)
LineApiResponse<GetGroupsResponse>	getGroups(java.lang.String nextPageRequestToken, boolean isForOttShareMessage)
LineApiResponse<LineProfile>	getProfile() Gets the user profile information.
LineApiResponse<?>	logout() Revokes the access token.
LineApiResponse<LineAccessToken>	refreshAccessToken() Refreshes the access token that the SDK is using for the user.
LineApiResponse<java.lang.String>	sendMessage(java.lang.String targetUserId, java.util.List<MessageData> messages)
LineApiResponse<java.util.List<SendMessageResponse>>	sendMessageToMultipleUsers(java.util.List<java.lang.String> targetUserIds, java.util.List<MessageData> messages)
LineApiResponse<java.util.List<SendMessageResponse>>	sendMessageToMultipleUsers(java.util.List<java.lang.String> targetUserIds, java.util.List<MessageData> messages, boolean isOttUsed) Sends messages to multiple users on behalf of the current user.
LineApiResponse<LineCredential>	verifyToken() Checks whether the access token that the SDK is using for the user is valid.

Method Detail

logout

@NonNull
LineApiResponse<?> logout()

Revokes the access token.

Returns:

A LineApiResponse object containing information about the response.

refreshAccessToken

@NonNull
LineApiResponse<LineAccessToken> refreshAccessToken()

Refreshes the access token that the SDK is using for the user.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a LineAccessToken object that contains a new access token. If the API call fails, the payload of the LineApiResponse object is null.

verifyToken

@NonNull
LineApiResponse<LineCredential> verifyToken()

Checks whether the access token that the SDK is using for the user is valid.

Returns:

A LineApiResponse object. If the access token is valid, the LineApiResponse object contains a success response and the LineCredential object that contains the access token. If the access token is invalid, the LineApiResponse object contains a failure response.

getCurrentAccessToken

@NonNull
LineApiResponse<LineAccessToken> getCurrentAccessToken()

Gets the access token that the SDK is using for the user.

Returns:

A LineApiResponse object. If the API call is successful, a LineApiResponse object contains the LineAccessToken object that contains the access token. If the API call fails, the payload of the LineApiResponse object is null.

getProfile

@NonNull
LineApiResponse<LineProfile> getProfile()

Gets the user profile information.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a LineProfile object that contains the user's profile. If the API call fails, the payload of the LineApiResponse object is null.

getFriendshipStatus

@NonNull
LineApiResponse<LineFriendshipStatus> getFriendshipStatus()

Gets the friendship status between the bot (which is linked to the current channel) and the user.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a LineFriendshipStatus object that contains the friendship status information. If the API call fails, the payload of the LineApiResponse object is null.

getFriends

@NonNull
LineApiResponse<GetFriendsResponse> getFriends(@NonNull
                                                        FriendSortField sortField,
                                                        @Nullable
                                                        java.lang.String nextPageRequestToken)

Parameters:

sortField - Optional. The way to sort the friend list. See the FriendSortField section for more information.

nextPageRequestToken - Optional. The continuation token to get the next friend list.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a GetFriendsResponse object that contains up to 200 friends of the user. The GetFriendsResponse object also contains a continuation token if there are remaining friends that the original API call didn't return. If the API call fails, the payload of the LineApiResponse object is

getFriends

@NonNull
LineApiResponse<GetFriendsResponse> getFriends(@NonNull
                                                        FriendSortField sortField,
                                                        @Nullable
                                                        java.lang.String nextPageRequestToken,
                                                        boolean isForOttShareMessage)

Parameters:

sortField - Optional. The way to sort the friend list. See the FriendSortField section for more information.

nextPageRequestToken - Optional. The continuation token to get the next friend list.

isForOttShareMessage - True if this API is called for sharing messages with OTT, false otherwise.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a GetFriendsResponse object that contains up to 200 friends of the user. The GetFriendsResponse object also contains a continuation token if there are remaining friends that the original API call didn't return. If the API call fails, the payload of the LineApiResponse object is null.

See Also:

FriendSortField

getFriendsApprovers

@NonNull
LineApiResponse<GetFriendsResponse> getFriendsApprovers(@NonNull
                                                                 FriendSortField sortField,
                                                                 @Nullable
                                                                 java.lang.String nextPageRequestToken)

Parameters:

sortField - Optional. The way to sort the friend list. See the FriendSortField section for more information.

nextPageRequestToken - Optional. The continuation token to get the next friend list.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a GetFriendsResponse object that contains up to 200 friends of the user. The GetFriendsResponse object also contains a continuation token if there are remaining friends that the original API call didn't return. If the API call fails, the payload of the LineApiResponse object is null.

See Also:

FriendSortField

getGroups

@NonNull
LineApiResponse<GetGroupsResponse> getGroups(@Nullable
                                                      java.lang.String nextPageRequestToken)

Parameters:

nextPageRequestToken - Optional. The continuation token to get the next group list.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a GetGroupsResponse object that contains up to 200 groups that the user is a member of. The GetGroupsResponse object also contains a continuation token if there are remaining groups that the original API call didn't return. If the API call fails, the payload of the LineApiResponse object is null.

getGroups

@NonNull
LineApiResponse<GetGroupsResponse> getGroups(@Nullable
                                                      java.lang.String nextPageRequestToken,
                                                      boolean isForOttShareMessage)

Parameters:

nextPageRequestToken - Optional. The continuation token to get the next group list.

isForOttShareMessage - True if this API is called for sharing messages with OTT, false otherwise.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a GetGroupsResponse object that contains up to 200 groups that the user is a member of. The GetGroupsResponse object also contains a continuation token if there are remaining groups that the original API call didn't return. If the API call fails, the payload of the LineApiResponse object is null.

getGroupApprovers

@NonNull
LineApiResponse<GetFriendsResponse> getGroupApprovers(@NonNull
                                                               java.lang.String groupId,
                                                               @Nullable
                                                               java.lang.String nextPageRequestToken)

Parameters:

groupId - Required. The ID of the group to get its members.

nextPageRequestToken - Optional. The continuation token to get the next member list.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains a GetFriendsResponse object that contains up to 200 members. The GetFriendsResponse object also contains a continuation token if there are remaining members that the original API call didn't return. If the API call fails, the payload of the LineApiResponse object is null.

sendMessage

@NonNull
LineApiResponse<java.lang.String> sendMessage(@NonNull
                                                       java.lang.String targetUserId,
                                                       @NonNull
                                                       java.util.List<MessageData> messages)

Parameters:

targetUserId - Required. The ID of the user or group that receives messages from the current user.

messages - Required. The messages to send. Available message types are: text, audio, image, location, video, and template. You can send up to five messages.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains the delivery result. If the API call fails, the payload of the LineApiResponse object is null. The delivery result is either of the followings:

• ok: The messages have been delivered successfully.
• discarded: The messages have been discarded because one of the conditions above is met. This code is returned only when you attempt to send messages to a user.

See Also:

MessageData

sendMessageToMultipleUsers

@NonNull
LineApiResponse<java.util.List<SendMessageResponse>> sendMessageToMultipleUsers(@NonNull
                                                                                         java.util.List<java.lang.String> targetUserIds,
                                                                                         @NonNull
                                                                                         java.util.List<MessageData> messages)

Parameters:

targetUserIds - The IDs of the users that receive messages from the user. You can specify up to 10 users.

messages - The messages to send. Available message types are: text, audio, image, location, video, and template. You can send up to five messages.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains the SendMessageResponse objects that contain the delivery results. If the API call fails, the payload of the LineApiResponse object is null. The delivery result is either of the followings:

• ok: The messages have been delivered successfully.
• discarded: The messages have been discarded because one of the conditions above is met or a server error occurred.

See Also:

SendMessageResponse

sendMessageToMultipleUsers

@NonNull
LineApiResponse<java.util.List<SendMessageResponse>> sendMessageToMultipleUsers(@NonNull
                                                                                         java.util.List<java.lang.String> targetUserIds,
                                                                                         @NonNull
                                                                                         java.util.List<MessageData> messages,
                                                                                         boolean isOttUsed)

Sends messages to multiple users on behalf of the current user. To know the message delivery result for each recipient, check the response data.

In the following cases, messages are not delivered even though the API call is successful. The response status is "discarded" for such API calls.

• The recipient has blocked the current user.
• The recipient has turned off messages from the channel.
• The recipient hasn't authorized the channel to use their profile information and has turned off messages from unauthorized channels.
• The current user is not a friend of the recipient that is not a bot but a human.

To call this method, you need a channel with the MESSAGE permission and an access token with the message.write scope.

Parameters:

targetUserIds - The IDs of the users that receive messages from the user. You can specify up to 10 users.

messages - The messages to send. Available message types are: text, audio, image, location, video, and template. You can send up to five messages.

isOttUsed - True if you want to send messages using OTT instead of using the user ids; false otherwise.

Returns:

A LineApiResponse object. If the API call is successful, the LineApiResponse object contains the SendMessageResponse objects that contain the delivery results. If the API call fails, the payload of the LineApiResponse object is null. The delivery result is either of the following:

• ok: The messages have been delivered successfully.
• discarded: The messages have been discarded because one of the conditions above is met or a server error occurred.

See Also:

SendMessageResponse