Support unsend event. (#565)

* Support unsend event.

* Add missing copyright header.

Author: tokuhirom

line-bot-model/src/main/java/com/linecorp/bot/model/event/Event.java

@@ -37,7 +37,8 @@
         @JsonSubTypes.Type(AccountLinkEvent.class),
         @JsonSubTypes.Type(ThingsEvent.class),
         @JsonSubTypes.Type(MemberJoinedEvent.class),
-        @JsonSubTypes.Type(MemberLeftEvent.class)
+        @JsonSubTypes.Type(MemberLeftEvent.class),
+        @JsonSubTypes.Type(UnsendEvent.class)
 })
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

line-bot-model/src/main/java/com/linecorp/bot/model/event/UnsendEvent.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2020 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.event;
+
+import java.time.Instant;
+
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+import com.linecorp.bot.model.event.source.Source;
+
+import lombok.Builder;
+import lombok.Value;
+
+/**
+ * Event object for when the user unsends a message in a group or room.
+ */
+@JsonTypeName("unsend")
+@Value
+@Builder(toBuilder = true)
+@JsonDeserialize(builder = UnsendEvent.UnsendEventBuilder.class)
+public class UnsendEvent implements Event {
+    @JsonPOJOBuilder(withPrefix = "")
+    public static class UnsendEventBuilder {
+        // Providing builder instead of public constructor. Class body is filled by lombok.
+    }
+
+    /**
+     * JSON object which contains the source of the event.
+     */
+    Source source;
+
+    /**
+     * Time of the event.
+     */
+    Instant timestamp;
+
+    /**
+     * Channel state.
+     * <dl>
+     * <dt>active</dt>
+     * <dd>The channel is active. You can send a reply message or push message from the bot server that received
+     * this webhook event.</dd>
+     * <dt>standby (under development)</dt>
+     * <dd>The channel is waiting. The bot server that received this webhook event shouldn't send any messages.
+     * </dd>
+     * </dl>
+     */
+    EventMode mode;
+
+    UnsendDetail unsend;
+
+    @Value
+    @Builder(toBuilder = true)
+    @JsonDeserialize(builder = UnsendDetail.UnsendDetailBuilder.class)
+    public static class UnsendDetail {
+        @JsonPOJOBuilder(withPrefix = "")
+        public static class UnsendDetailBuilder {
+            // Providing builder instead of public constructor. Class body is filled by lombok.
+        }
+
+        /**
+         * The message ID of the unsent message.
+         */
+        String messageId;
+    }
+}

line-bot-model/src/test/java/com/linecorp/bot/model/event/CallbackRequestTest.java

@@ -563,6 +563,22 @@ public void testMemberLeft() throws IOException {
         });
     }
 
+    @Test
+    public void testUnsend() throws IOException {
+        parse("callback/unsend.json", callbackRequest -> {
+            assertDestination(callbackRequest);
+            Event event = callbackRequest.getEvents().get(0);
+            assertThat(event.getSource()).isInstanceOf(UserSource.class);
+            assertThat(event).isInstanceOf(UnsendEvent.class);
+            assertThat(event.getMode())
+                    .isEqualTo(EventMode.ACTIVE);
+
+            UnsendEvent unsendEvent = (UnsendEvent) event;
+            String messageId = unsendEvent.getUnsend().getMessageId();
+            assertThat(messageId).isEqualTo("325708");
+        });
+    }
+
     // Event, that has brand new eventType
     @Test
     public void testUnknown() throws IOException {

line-bot-model/src/test/resources/callback/unsend.json

@@ -0,0 +1,17 @@
+{
+  "destination": "Uab012345678901234567890123456789",
+  "events": [
+    {
+      "type": "unsend",
+      "timestamp": 1462629479859,
+      "mode": "active",
+      "source": {
+        "type": "user",
+        "userId": "u206d25c2ea6bd87c17655609a1c37cb8"
+      },
+      "unsend": {
+        "messageId": "325708"
+      }
+    }
+  ]
+}

sample-spring-boot-kitchensink/src/main/java/com/example/bot/spring/KitchenSinkController.java

@@ -56,6 +56,7 @@
 import com.linecorp.bot.model.event.MessageEvent;
 import com.linecorp.bot.model.event.PostbackEvent;
 import com.linecorp.bot.model.event.UnfollowEvent;
+import com.linecorp.bot.model.event.UnsendEvent;
 import com.linecorp.bot.model.event.message.AudioMessageContent;
 import com.linecorp.bot.model.event.message.ContentProvider;
 import com.linecorp.bot.model.event.message.FileMessageContent;
@@ -254,6 +255,11 @@ public void handleMemberLeft(MemberLeftEvent event) {
                                                     .collect(Collectors.joining(",")));
     }
 
+    @EventMapping
+    public void handleMemberLeft(UnsendEvent event) {
+        log.info("Got unsend event: {}", event);
+    }
+
     @EventMapping
     public void handleOtherEvent(Event event) {
         log.info("Received message(Ignored): {}", event);