Support message broadcast

Author: imasahiro

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClient.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
+import com.linecorp.bot.model.Broadcast;
 import com.linecorp.bot.model.Multicast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
@@ -74,6 +75,14 @@ public interface LineMessagingClient {
      */
     CompletableFuture<BotApiResponse> multicast(Multicast multicast);
 
+    /**
+     * 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 <a href="https://developers.line.biz/en/docs/messaging-api/migrating-line-at/">
+     * Migration of LINE@ accounts</a>.
+     */
+    CompletableFuture<BotApiResponse> broadcast(Broadcast broadcast);
+
     /**
      * Download image, video, and audio data sent from users.
      *

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingClientImpl.java

@@ -23,6 +23,7 @@
 import java.util.function.Function;
 
 import com.linecorp.bot.client.exception.GeneralLineMessagingException;
+import com.linecorp.bot.model.Broadcast;
 import com.linecorp.bot.model.Multicast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
@@ -78,6 +79,11 @@ public CompletableFuture<BotApiResponse> multicast(final Multicast multicast) {
         return toFuture(retrofitImpl.multicast(multicast));
     }
 
+    @Override
+    public CompletableFuture<BotApiResponse> broadcast(Broadcast broadcast) {
+        return toFuture(retrofitImpl.broadcast(broadcast));
+    }
+
     @Override
     public CompletableFuture<MessageContentResponse> getMessageContent(final String messageId) {
         return toMessageContentResponseFuture(retrofitImpl.getMessageContent(messageId));

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineMessagingService.java

@@ -18,6 +18,7 @@
 
 import java.util.List;
 
+import com.linecorp.bot.model.Broadcast;
 import com.linecorp.bot.model.Multicast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
@@ -74,6 +75,12 @@ interface LineMessagingService {
     @POST("v2/bot/message/multicast")
     Call<BotApiResponse> multicast(@Body Multicast multicast);
 
+    /**
+     * Sends push messages to multiple users at any time.
+     */
+    @POST("v2/bot/message/broadcast")
+    Call<BotApiResponse> broadcast(@Body Broadcast broadcast);
+
     /**
      * Method for Retrofit.
      *

line-bot-api-client/src/test/java/com/linecorp/bot/client/LineMessagingClientImplTest.java

@@ -37,6 +37,7 @@
 import org.mockito.junit.MockitoRule;
 import org.mockito.stubbing.OngoingStubbing;
 
+import com.linecorp.bot.model.Broadcast;
 import com.linecorp.bot.model.Multicast;
 import com.linecorp.bot.model.PushMessage;
 import com.linecorp.bot.model.ReplyMessage;
@@ -124,6 +125,16 @@ public void multicastTest() throws Exception {
         assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
     }
 
+    @Test
+    public void broadcast() {
+        whenCall(retrofitMock.broadcast(any()), BOT_API_SUCCESS_RESPONSE);
+        final Broadcast broadcast = new Broadcast(Collections.singletonList(new TextMessage("text")), true);
+
+        final BotApiResponse botApiResponse = target.broadcast(broadcast).join();
+        verify(retrofitMock).broadcast(broadcast);
+        assertThat(botApiResponse).isEqualTo(BOT_API_SUCCESS_RESPONSE);
+    }
+
     @Test
     public void getMessageContentTest() throws Exception {
         whenCall(retrofitMock.getMessageContent(any()),

line-bot-model/src/main/java/com/linecorp/bot/model/Broadcast.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2019 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.linecorp.bot.model;
+
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+
+import com.linecorp.bot.model.message.Message;
+
+import lombok.AllArgsConstructor;
+import lombok.Value;
+
+/**
+ * Sends push messages to multiple users at any time.
+ */
+@Value
+@AllArgsConstructor(onConstructor = @__(@JsonCreator))
+public class Broadcast {
+
+    /**
+     * List of Message objects.
+     *
+     * <p>Max: 5
+     */
+    List<Message> messages;
+
+    /**
+     * Whether sends a push notification to message receivers or not. If {@literal true}, the user doesn't
+     * receive a push notification when the message is sent. And if {@literal false}, the user receives a push
+     * notification when the message is sent (unless they have disabled push notifications in LINE and/or their
+     * device).
+     */
+    boolean notificationDisabled;
+}

line-bot-model/src/test/java/com/linecorp/bot/model/message/MessageJsonReconstructionTest.java

@@ -30,6 +30,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+import com.linecorp.bot.model.Broadcast;
 import com.linecorp.bot.model.Multicast;
 import com.linecorp.bot.model.action.CameraAction;
 import com.linecorp.bot.model.action.CameraRollAction;
@@ -175,6 +176,13 @@ public void multicastTest() {
         test(multicast);
     }
 
+    @Test
+    public void broadcast() {
+        final Broadcast broadcast = new Broadcast(singletonList(new TextMessage("text")), true);
+
+        test(broadcast);
+    }
+
     ////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
     void test(final Object original) {