com.linecorp.linesdk.message

Class MessageSendRequest

java.lang.Object

com.linecorp.linesdk.message.MessageSendRequest

public class MessageSendRequest
extends java.lang.Object

Represents message data to be sent via the User Message API.

There are three types of message data.

For example,

message data using a single user id:

 {
      "to": "ue97cd0e6646fd73eee758761ca376a15",
      "messages": [
          {
              "type": "buttons",
              "text": "ButtonsLayoutTemplate LayoutTemplate",
              ...
          }
      ]
 }

Message data using multiple user ids:

 {
      "to": [
                "cb7e0f5b861d704ae00cea5105620e730",
                "ue97cd0e6646fd73eee758761ca376a15"
      ],
      "messages": [
          {
              "type": "buttons",
              "text": "ButtonsLayoutTemplate LayoutTemplate",
              ...
          }
      ]
 }

Message data using OTT:

 {
      "token": "f64e13f2-1658-4dde-bac4-a3bb5fb94bbd",
      "messages": [
          {
              "type": "buttons",
              "text": "ButtonsLayoutTemplate LayoutTemplate",
              ...
          }
      ]
 }

Method Summary

Modifier and Type	Method and Description
static MessageSendRequest	createMultiUsersType(java.util.List<java.lang.String> targetUserIds, java.util.List<MessageData> messages) Create a MessageSendRequest object with multiple recipients and multiple messages.
static MessageSendRequest	createOttType(java.lang.String ott, java.util.List<MessageData> messages) Construct a MessageSendRequest object with OTT and multiple messages.
static MessageSendRequest	createSingleUserType(java.lang.String targetUserId, java.util.List<MessageData> messages) Create a MessageSendRequest object with a single recipient and multiple messages.
java.lang.String	toJsonString()

Methods inherited from class java.lang.Object

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

Method Detail

createSingleUserType

public static MessageSendRequest createSingleUserType(@NonNull
                                                      java.lang.String targetUserId,
                                                      @NonNull
                                                      java.util.List<MessageData> messages)

Create a MessageSendRequest object with a single recipient and multiple messages.

Parameters:

targetUserId - Required. The recipient's user ID.

messages - Required. A list of MessageData objects.

createMultiUsersType

public static MessageSendRequest createMultiUsersType(@NonNull
                                                      java.util.List<java.lang.String> targetUserIds,
                                                      @NonNull
                                                      java.util.List<MessageData> messages)

Create a MessageSendRequest object with multiple recipients and multiple messages.

Parameters:

targetUserIds - Required. A list of the recipients' user IDs.

messages - Required. A list of MessageData objects.

createOttType

public static MessageSendRequest createOttType(@NonNull
                                               java.lang.String ott,
                                               @NonNull
                                               java.util.List<MessageData> messages)

Construct a MessageSendRequest object with OTT and multiple messages.

Parameters:

ott - Required. One time token.

messages - Required. A list of MessageData objects.

toJsonString

@NonNull
public java.lang.String toJsonString()
                                       throws JSONException

Throws:

JSONException