chore: improve docs / bump to alpha.4

twitch4j · Dec 21, 2018 · cea8198 · cea8198
1 parent 110a508
commit cea8198
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 7 deletions.
diff --git a/docs/content/events/_index.md b/docs/content/events/_index.md
@@ -1,6 +1,6 @@
 +++
 title="Events"
-weight = 150
+weight = 200
 +++
 
 # Events
@@ -10,5 +10,13 @@ Twitch4J triggers various internal events you can listen to to build chat bots o
 
 ## Event Catalogue
 
-* [IRCMessageEvent](./IrcMessageEvent)
-* [ChannelMessageEvent](./ChannelMessageEvent)
+
+
+Channel:
+* [ChannelMessageEvent](./channel-message-event)
+
+User:
+* [PrivateMessageEvent](./private-message-event)
+
+Generic:
+* [IRCMessageEvent](./irc-message-event)
diff --git a/docs/content/events/ChannelMessageEvent.md → docs/content/events/channel-message-event.md b/docs/content/events/ChannelMessageEvent.md → docs/content/events/channel-message-event.md
diff --git a/docs/content/events/IrcMessageEvent.md → docs/content/events/irc-message-event.md b/docs/content/events/IrcMessageEvent.md → docs/content/events/irc-message-event.md
diff --git a/docs/content/events/private-message-event.md b/docs/content/events/private-message-event.md
@@ -0,0 +1,25 @@
++++
+title="User - Private Message / Whisper"
+weight = 210
++++
+
+# PrivateMessageEvent
+
+## Description
+
+The PrivateMessageEvent is triggered for private messages / whispers and can be triggered from PubSub or Chat.
+
+## Dependencies
+
+Requires the TwitchChat Module to be enabled and active for the source channel. See [TwitchChat](../chat).
+Otherwise you will need to enable [PubSub](../pubsub) and subscribe to the whispers topic the receive PrivateMessageEvents.
+
+## Examples
+
+### Listen for PrivateMessageEvent
+
+```java
+eventManager.onEvent(PrivateMessageEvent.class).subscribe(event -> {
+	System.out.println("[Whisper] " + event.getUser().getName() + ": " + event.getMessage());
+});
+```
diff --git a/docs/content/getting-started/installation.md b/docs/content/getting-started/installation.md
@@ -19,7 +19,7 @@ and: (latest, you should use the actual version here)
 
 ```groovy
 dependencies {
-    compile group: 'com.github.twitch4j', name: 'twitch4j', '1.0.0-alpha.3'
+    compile group: 'com.github.twitch4j', name: 'twitch4j', '1.0.0-alpha.4'
 }
 ```
 
@@ -43,7 +43,7 @@ and: (latest, you should use the actual version here)
 <dependency>
     <groupId>com.github.twitch4j</groupId>
     <artifactId>twitch4j</artifactId>
-    <version>1.0.0-alpha.3</version>
+    <version>1.0.0-alpha.4</version>
 </dependency>
 ```
 

diff --git a/docs/content/graphql/_index.md b/docs/content/graphql/_index.md
@@ -1,6 +1,6 @@
 +++
 title="GraphQL"
-weight = 200
+weight = 150
 +++
 
 # Twitch4J - GraphQL

diff --git a/docs/content/rest-helix/_index.md b/docs/content/rest-helix/_index.md
@@ -114,7 +114,7 @@ Games:
 Streams:
 
 - [Streams -> Search](./streams-get)
-- [Streams -> Get Metadata](./streams-getMetadata)
+- [Streams -> Get Metadata](./streams-getmetadata)
 - Create Stream Marker
 - [Streams -> Get Markers](./streams-markers-get)
 

diff --git a/twitch4j/src/test/java/com/github/twitch4j/TwitchClientTest.java b/twitch4j/src/test/java/com/github/twitch4j/TwitchClientTest.java
@@ -1,7 +1,9 @@
 package com.github.twitch4j;
 
 import com.github.philippheuer.events4j.EventManager;
+import com.github.twitch4j.common.events.user.PrivateMessageEvent;
 import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
@@ -28,4 +30,28 @@ public void buildTwitch4J() {
             .build();
     }
 
+    /**
+     * Debugging
+     */
+    @Test
+    @DisplayName("Test for local execution in error diagnostics")
+    @Disabled
+    public void localTest() {
+        // external event manager (for shared module usage - streamlabs4j)
+        EventManager eventManager = new EventManager();
+
+        // construct twitchClient
+        TwitchClient twitchClient = TwitchClientBuilder.builder()
+            .withEventManager(eventManager)
+            .withEnableHelix(true)
+            .withEnableKraken(true)
+            .withEnableChat(false)
+            .build();
+
+        // register all event listeners
+        eventManager.onEvent(PrivateMessageEvent.class).subscribe(event -> {
+            System.out.println("[Whisper] " + event.getUser().getName() + ": " + event.getMessage());
+        });
+    }
+
 }