Skip to content

Commit

Permalink
Update doc and code example on RealTimeEvent listener (#759)
Browse files Browse the repository at this point in the history 
update doc and the code examples to reflect the changes done
in the PR #748.
  • Loading branch information
@yinan-symphony
yinan-symphony committed Apr 20, 2023
1 parent 91f2878 commit 4f23a83
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 37 deletions.
34 changes: 17 additions & 17 deletions docs/spring-boot/core-starter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public class HelloBot {
private MessageService messageService;

@EventListener
public void onMessageSent(RealTimeEvent<V4MessageSent> event) {
public void onMessageSent(RealTimeEvent<? extends V4MessageSent> event) {
log.info("event was triggered at {}", ((EventPayload) event.getSource()).getEventTimestamp());
this.messageService.send(event.getSource().getMessage().getStream(), "<messageML>Hello!</messageML>");
}
Expand Down Expand Up @@ -199,52 +199,52 @@ Here's the list of Real Time Events you can subscribe:
public class RealTimeEvents {

@EventListener
public void onMessageSent(RealTimeEvent<V4MessageSent> event) {}
public void onMessageSent(RealTimeEvent<? extends V4MessageSent> event) {}

@EventListener
public void onSharedPost(RealTimeEvent<V4SharedPost> event) {}
public void onSharedPost(RealTimeEvent<? extends V4SharedPost> event) {}

@EventListener
public void onInstantMessageCreated(RealTimeEvent<V4InstantMessageCreated> event) {}
public void onInstantMessageCreated(RealTimeEvent<? extends V4InstantMessageCreated> event) {}

@EventListener
public void onRoomCreated(RealTimeEvent<V4RoomCreated> event) {}
public void onRoomCreated(RealTimeEvent<? extends V4RoomCreated> event) {}

@EventListener
public void onRoomUpdated(RealTimeEvent<V4RoomUpdated> event) {}
public void onRoomUpdated(RealTimeEvent<? extends V4RoomUpdated> event) {}

@EventListener
public void onRoomDeactivated(RealTimeEvent<V4RoomDeactivated> event) {}
public void onRoomDeactivated(RealTimeEvent<? extends V4RoomDeactivated> event) {}

@EventListener
public void onRoomReactivated(RealTimeEvent<V4RoomReactivated> event) {}
public void onRoomReactivated(RealTimeEvent<? extends V4RoomReactivated> event) {}

@EventListener
public void onUserRequestedToJoinRoom(RealTimeEvent<V4UserRequestedToJoinRoom> event) {}
public void onUserRequestedToJoinRoom(RealTimeEvent<? extends V4UserRequestedToJoinRoom> event) {}

@EventListener
public void onUserJoinedRoom(RealTimeEvent<V4UserJoinedRoom> event) {}
public void onUserJoinedRoom(RealTimeEvent<? extends V4UserJoinedRoom> event) {}

@EventListener
public void onUserLeftRoom(RealTimeEvent<V4UserLeftRoom> event) {}
public void onUserLeftRoom(RealTimeEvent<? extends V4UserLeftRoom> event) {}

@EventListener
public void onRoomMemberPromotedToOwner(RealTimeEvent<V4RoomMemberPromotedToOwner> event) {}
public void onRoomMemberPromotedToOwner(RealTimeEvent<? extends V4RoomMemberPromotedToOwner> event) {}

@EventListener
public void onRoomMemberDemotedFromOwner(RealTimeEvent<V4RoomMemberDemotedFromOwner> event) {}
public void onRoomMemberDemotedFromOwner(RealTimeEvent<? extends V4RoomMemberDemotedFromOwner> event) {}

@EventListener
public void onConnectionRequested(RealTimeEvent<V4ConnectionRequested> event) {}
public void onConnectionRequested(RealTimeEvent<? extends V4ConnectionRequested> event) {}

@EventListener
public void onConnectionAccepted(RealTimeEvent<V4ConnectionAccepted> event) {}
public void onConnectionAccepted(RealTimeEvent<? extends V4ConnectionAccepted> event) {}

@EventListener
public void onMessageSuppressed(RealTimeEvent<V4MessageSuppressed> event) {}
public void onMessageSuppressed(RealTimeEvent<? extends V4MessageSuppressed> event) {}

@EventListener
public void onSymphonyElementsAction(RealTimeEvent<V4SymphonyElementsAction> event) {}
public void onSymphonyElementsAction(RealTimeEvent<? extends V4SymphonyElementsAction> event) {}
}
```

Expand Down
6 changes: 3 additions & 3 deletions ...pring-boot-example/src/main/java/com/symphony/bdk/examples/spring/RealTimeEventsDemo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@
public class RealTimeEventsDemo {

@EventListener
public void onMessageSent(RealTimeEvent<V4MessageSent> event) {
public void onMessageSent(RealTimeEvent<? extends V4MessageSent> event) {
log.info("{} received at {}", event.toString(), ((EventPayload) event.getSource()).getEventTimestamp());
}

@EventListener
public void onUserJoined(RealTimeEvent<V4UserJoinedRoom> event) {
public void onUserJoined(RealTimeEvent<? extends V4UserJoinedRoom> event) {
log.info(event.toString());
}

@EventListener
public void onUserLeft(RealTimeEvent<V4UserLeftRoom> event) {
public void onUserLeft(RealTimeEvent<? extends V4UserLeftRoom> event) {
log.info(event.toString());
}
}
2 changes: 1 addition & 1 deletion ...starter/src/test/java/com/symphony/bdk/spring/events/RealTimeEventsAsyncTestListener.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
public class RealTimeEventsAsyncTestListener {

@EventListener
public void onSymphonyElementsAction(RealTimeEvent<V4SymphonyElementsAction> event) {
public void onSymphonyElementsAction(RealTimeEvent<? extends V4SymphonyElementsAction> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
// Test the MDC values have been copied from the parent thread
Expand Down
32 changes: 16 additions & 16 deletions ...boot-starter/src/test/java/com/symphony/bdk/spring/events/RealTimeEventsTestListener.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,97 +29,97 @@
public class RealTimeEventsTestListener {

@EventListener
public void onMessageSent(RealTimeEvent<V4MessageSent> event) {
public void onMessageSent(RealTimeEvent<? extends V4MessageSent> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onSharedPost(RealTimeEvent<V4SharedPost> event) {
public void onSharedPost(RealTimeEvent<? extends V4SharedPost> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onInstantMessageCreated(RealTimeEvent<V4InstantMessageCreated> event) {
public void onInstantMessageCreated(RealTimeEvent<? extends V4InstantMessageCreated> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onRoomCreated(RealTimeEvent<V4RoomCreated> event) {
public void onRoomCreated(RealTimeEvent<? extends V4RoomCreated> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onRoomUpdated(RealTimeEvent<V4RoomUpdated> event) {
public void onRoomUpdated(RealTimeEvent<? extends V4RoomUpdated> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onRoomDeactivated(RealTimeEvent<V4RoomDeactivated> event) {
public void onRoomDeactivated(RealTimeEvent<? extends V4RoomDeactivated> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onRoomReactivated(RealTimeEvent<V4RoomReactivated> event) {
public void onRoomReactivated(RealTimeEvent<? extends V4RoomReactivated> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onUserRequestedToJoinRoom(RealTimeEvent<V4UserRequestedToJoinRoom> event) {
public void onUserRequestedToJoinRoom(RealTimeEvent<? extends V4UserRequestedToJoinRoom> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onUserJoinedRoom(RealTimeEvent<V4UserJoinedRoom> event) {
public void onUserJoinedRoom(RealTimeEvent<? extends V4UserJoinedRoom> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onUserLeftRoom(RealTimeEvent<V4UserLeftRoom> event) {
public void onUserLeftRoom(RealTimeEvent<? extends V4UserLeftRoom> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onRoomMemberPromotedToOwner(RealTimeEvent<V4RoomMemberPromotedToOwner> event) {
public void onRoomMemberPromotedToOwner(RealTimeEvent<? extends V4RoomMemberPromotedToOwner> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onRoomMemberDemotedFromOwner(RealTimeEvent<V4RoomMemberDemotedFromOwner> event) {
public void onRoomMemberDemotedFromOwner(RealTimeEvent<? extends V4RoomMemberDemotedFromOwner> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onConnectionRequested(RealTimeEvent<V4ConnectionRequested> event) {
public void onConnectionRequested(RealTimeEvent<? extends V4ConnectionRequested> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onConnectionAccepted(RealTimeEvent<V4ConnectionAccepted> event) {
public void onConnectionAccepted(RealTimeEvent<? extends V4ConnectionAccepted> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onMessageSuppressed(RealTimeEvent<V4MessageSuppressed> event) {
public void onMessageSuppressed(RealTimeEvent<? extends V4MessageSuppressed> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}

@EventListener
public void onSymphonyElementsAction(RealTimeEvent<V4SymphonyElementsAction> event) {
public void onSymphonyElementsAction(RealTimeEvent<? extends V4SymphonyElementsAction> event) {
Objects.requireNonNull(event.getInitiator());
Objects.requireNonNull(event.getSource());
}
Expand Down

0 comments on commit 4f23a83

Please sign in to comment.