Skip to content

Commit

Permalink
feat: update javadocs to v1.18.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@PhilippHeuer
PhilippHeuer committed Nov 16, 2023
1 parent 12b4cec commit 2e5d557
Show file tree
Hide file tree
Showing 1,253 changed files with 25,994 additions and 4,055 deletions.
970 changes: 582 additions & 388 deletions docs/static/javadoc/allclasses-index.html
View file

Large diffs are not rendered by default.

64 changes: 34 additions & 30 deletions docs/static/javadoc/allpackages-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>All Packages (Twitch4J (v1.15.0))</title>
<title>All Packages (Twitch4J (v1.18.0))</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="package index">
Expand Down Expand Up @@ -118,63 +118,67 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/domain/package-summary.html">com.github.twitch4j.eventsub.domain</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/events/package-summary.html">com.github.twitch4j.eventsub.events</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/domain/chat/package-summary.html">com.github.twitch4j.eventsub.domain.chat</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/events/batched/package-summary.html">com.github.twitch4j.eventsub.events.batched</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/events/package-summary.html">com.github.twitch4j.eventsub.events</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/socket/package-summary.html">com.github.twitch4j.eventsub.socket</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/events/batched/package-summary.html">com.github.twitch4j.eventsub.events.batched</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/socket/domain/package-summary.html">com.github.twitch4j.eventsub.socket.domain</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/socket/package-summary.html">com.github.twitch4j.eventsub.socket</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/socket/enums/package-summary.html">com.github.twitch4j.eventsub.socket.enums</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/socket/domain/package-summary.html">com.github.twitch4j.eventsub.socket.domain</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/socket/events/package-summary.html">com.github.twitch4j.eventsub.socket.events</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/socket/enums/package-summary.html">com.github.twitch4j.eventsub.socket.enums</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/subscriptions/package-summary.html">com.github.twitch4j.eventsub.subscriptions</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/socket/events/package-summary.html">com.github.twitch4j.eventsub.socket.events</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/util/package-summary.html">com.github.twitch4j.eventsub.util</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/eventsub/subscriptions/package-summary.html">com.github.twitch4j.eventsub.subscriptions</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/extensions/package-summary.html">com.github.twitch4j.extensions</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/eventsub/util/package-summary.html">com.github.twitch4j.eventsub.util</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/extensions/compat/package-summary.html">com.github.twitch4j.extensions.compat</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/extensions/package-summary.html">com.github.twitch4j.extensions</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/extensions/domain/package-summary.html">com.github.twitch4j.extensions.domain</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/extensions/compat/package-summary.html">com.github.twitch4j.extensions.compat</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/extensions/util/package-summary.html">com.github.twitch4j.extensions.util</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/extensions/domain/package-summary.html">com.github.twitch4j.extensions.domain</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/graphql/package-summary.html">com.github.twitch4j.graphql</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/extensions/util/package-summary.html">com.github.twitch4j.extensions.util</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/graphql/command/package-summary.html">com.github.twitch4j.graphql.command</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/graphql/package-summary.html">com.github.twitch4j.graphql</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/helix/package-summary.html">com.github.twitch4j.helix</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/graphql/command/package-summary.html">com.github.twitch4j.graphql.command</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/helix/domain/package-summary.html">com.github.twitch4j.helix.domain</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/helix/package-summary.html">com.github.twitch4j.helix</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/helix/interceptor/package-summary.html">com.github.twitch4j.helix.interceptor</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/helix/domain/package-summary.html">com.github.twitch4j.helix.domain</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/helix/webhooks/domain/package-summary.html">com.github.twitch4j.helix.webhooks.domain</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/helix/interceptor/package-summary.html">com.github.twitch4j.helix.interceptor</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/helix/webhooks/topics/package-summary.html">com.github.twitch4j.helix.webhooks.topics</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/helix/webhooks/domain/package-summary.html">com.github.twitch4j.helix.webhooks.domain</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/internal/package-summary.html">com.github.twitch4j.internal</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/helix/webhooks/topics/package-summary.html">com.github.twitch4j.helix.webhooks.topics</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/kraken/package-summary.html">com.github.twitch4j.kraken</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/internal/package-summary.html">com.github.twitch4j.internal</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/kraken/domain/package-summary.html">com.github.twitch4j.kraken.domain</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/kraken/package-summary.html">com.github.twitch4j.kraken</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/kraken/util/package-summary.html">com.github.twitch4j.kraken.util</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/kraken/domain/package-summary.html">com.github.twitch4j.kraken.domain</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/modules/package-summary.html">com.github.twitch4j.modules</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/kraken/util/package-summary.html">com.github.twitch4j.kraken.util</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/modules/event/package-summary.html">com.github.twitch4j.modules.event</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/modules/package-summary.html">com.github.twitch4j.modules</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/pubsub/package-summary.html">com.github.twitch4j.pubsub</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/modules/event/package-summary.html">com.github.twitch4j.modules.event</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/pubsub/domain/package-summary.html">com.github.twitch4j.pubsub.domain</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/pubsub/package-summary.html">com.github.twitch4j.pubsub</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/pubsub/enums/package-summary.html">com.github.twitch4j.pubsub.enums</a></div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/pubsub/domain/package-summary.html">com.github.twitch4j.pubsub.domain</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/pubsub/events/package-summary.html">com.github.twitch4j.pubsub.events</a></div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/pubsub/enums/package-summary.html">com.github.twitch4j.pubsub.enums</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/pubsub/events/package-summary.html">com.github.twitch4j.pubsub.events</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="com/github/twitch4j/pubsub/handlers/package-summary.html">com.github.twitch4j.pubsub.handlers</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="com/github/twitch4j/tmi/package-summary.html">com.github.twitch4j.tmi</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
Expand Down
17 changes: 13 additions & 4 deletions docs/static/javadoc/com/github/twitch4j/IClientHelper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>IClientHelper (Twitch4J (v1.15.0))</title>
<title>IClientHelper (Twitch4J (v1.18.0))</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: com.github.twitch4j, interface: IClientHelper">
Expand Down Expand Up @@ -273,7 +273,10 @@ <h3>enableFollowEventListener</h3>
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;channelName)</span></div>
<div class="block">Enable Follow Listener, without invoking a Helix API call
<p>
WARNING: This will eventually require defaultAuthToken to represent the channel (or a moderator), due to Twitch scope changes.</div>
For <a href="chat/events/channel/FollowEvent.html" title="class in com.github.twitch4j.chat.events.channel"><code>FollowEvent</code></a> to fire, defaultAuthToken must be a user access token from a moderator of the channel
with the <a href="auth/domain/TwitchScopes.html#HELIX_CHANNEL_FOLLOWERS_READ"><code>TwitchScopes.HELIX_CHANNEL_FOLLOWERS_READ</code></a> scope.
Otherwise, the client helper can only fire <a href="events/ChannelFollowCountUpdateEvent.html" title="class in com.github.twitch4j.events"><code>ChannelFollowCountUpdateEvent</code></a>
due to Twitch restrictions implemented on 2023-09-12.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>channelId</code> - Channel Id</dd>
Expand Down Expand Up @@ -406,7 +409,10 @@ <h3>enableFollowEventListener</h3>
</span><span class="modifiers">default</span>&nbsp;<span class="return-type">@Nullable <a href="helix/domain/User.html" title="class in com.github.twitch4j.helix.domain">User</a></span>&nbsp;<span class="element-name">enableFollowEventListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;channelName)</span></div>
<div class="block">Enable Follow Listener for the given channel name
<p>
WARNING: This will eventually require defaultAuthToken to represent the channel (or a moderator), due to Twitch scope changes.</div>
For <a href="chat/events/channel/FollowEvent.html" title="class in com.github.twitch4j.chat.events.channel"><code>FollowEvent</code></a> to fire, defaultAuthToken must be a user access token from a moderator of the channel
with the <a href="auth/domain/TwitchScopes.html#HELIX_CHANNEL_FOLLOWERS_READ"><code>TwitchScopes.HELIX_CHANNEL_FOLLOWERS_READ</code></a> scope.
Otherwise, the client helper can only fire <a href="events/ChannelFollowCountUpdateEvent.html" title="class in com.github.twitch4j.events"><code>ChannelFollowCountUpdateEvent</code></a>
due to Twitch restrictions implemented on 2023-09-12.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>channelName</code> - Channel Name</dd>
Expand All @@ -419,7 +425,10 @@ <h3>enableFollowEventListener</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="helix/domain/User.html" title="class in com.github.twitch4j.helix.domain">User</a>&gt;</span>&nbsp;<span class="element-name">enableFollowEventListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;channelNames)</span></div>
<div class="block">Enable Follow Listener for the given channel names
<p>
WARNING: This will eventually require defaultAuthToken to represent the channel (or a moderator), due to Twitch scope changes.</div>
For <a href="chat/events/channel/FollowEvent.html" title="class in com.github.twitch4j.chat.events.channel"><code>FollowEvent</code></a> to fire, defaultAuthToken must be a user access token from a moderator of the channel
with the <a href="auth/domain/TwitchScopes.html#HELIX_CHANNEL_FOLLOWERS_READ"><code>TwitchScopes.HELIX_CHANNEL_FOLLOWERS_READ</code></a> scope.
Otherwise, the client helper can only fire <a href="events/ChannelFollowCountUpdateEvent.html" title="class in com.github.twitch4j.events"><code>ChannelFollowCountUpdateEvent</code></a>
due to Twitch restrictions implemented on 2023-09-12.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>channelNames</code> - the channel names to be added</dd>
Expand Down
2 changes: 1 addition & 1 deletion docs/static/javadoc/com/github/twitch4j/ITwitchClient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ITwitchClient (Twitch4J (v1.15.0))</title>
<title>ITwitchClient (Twitch4J (v1.18.0))</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: com.github.twitch4j, interface: ITwitchClient">
Expand Down
2 changes: 1 addition & 1 deletion docs/static/javadoc/com/github/twitch4j/LocalRun.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>LocalRun (Twitch4J (v1.15.0))</title>
<title>LocalRun (Twitch4J (v1.18.0))</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: com.github.twitch4j, class: LocalRun">
Expand Down
Loading

0 comments on commit 2e5d557

Please sign in to comment.