Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: deprecate helix get banned,moderator,subscription events #474

Merged
merged 1 commit into from
Dec 5, 2021
Merged

chore: deprecate helix get banned,moderator,subscription events #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,10 @@ default HystrixCommand<BannedUserList> getBannedUsers(
* @param after Optional: Cursor for forward pagination.
* @param limit Optional: Maximum number of objects to return. Maximum: 100. Default: 20.
* @return BannedEventList
* @see <a href="https://discuss.dev.twitch.tv/t/deprecation-of-twitch-api-event-endpoints-that-supported-websub-based-webhooks/35137">Deprecation announcement</a>
* @deprecated Will be removed come March 15, 2022, in favor of EventSub and {@link #getBannedUsers(String, String, List, String, String, Integer)}
*/
@Deprecated
@RequestLine("GET /moderation/banned/events?broadcaster_id={broadcaster_id}&user_id={user_id}&after={after}&first={first}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<BannedEventList> getBannedEvents(
Expand Down Expand Up @@ -1130,13 +1133,16 @@ default HystrixCommand<ModeratorList> getModerators(
/**
* Returns a list of moderators or users added and removed as moderators from a channel.
*
* @param authToken User Token for the broadcaster
* @param authToken User Token for the broadcaster
* @param broadcasterId Provided broadcaster_id must match the user_id in the auth token.
* @param userIds Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
* @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
* @param limit Maximum number of objects to return. Maximum: 100. Default: 20.
* @param userIds Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
* @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
* @param limit Maximum number of objects to return. Maximum: 100. Default: 20.
* @return ModeratorList
* @see <a href="https://discuss.dev.twitch.tv/t/deprecation-of-twitch-api-event-endpoints-that-supported-websub-based-webhooks/35137">Deprecation announcement</a>
* @deprecated Will be removed come March 15, 2022, in favor of EventSub and {@link #getModerators(String, String, List, String, Integer)}
*/
@Deprecated
@RequestLine(value = "GET /moderation/moderators/events?broadcaster_id={broadcaster_id}&user_id={user_id}&after={after}&first={first}", collectionFormat = CollectionFormat.CSV)
@Headers("Authorization: Bearer {token}")
HystrixCommand<ModeratorEventList> getModeratorEvents(
Expand All @@ -1150,11 +1156,12 @@ HystrixCommand<ModeratorEventList> getModeratorEvents(
/**
* Returns a list of moderators or users added and removed as moderators from a channel.
*
* @param authToken User Token for the broadcaster
* @param authToken User Token for the broadcaster
* @param broadcasterId Provided broadcaster_id must match the user_id in the auth token.
* @param userIds Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
* @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
* @param userIds Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
* @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
* @return ModeratorList
* @see <a href="https://discuss.dev.twitch.tv/t/deprecation-of-twitch-api-event-endpoints-that-supported-websub-based-webhooks/35137">Deprecation announcement</a>
* @deprecated in favor of getModeratorEvents(String, String, List, String, Integer) where the last param is the number of objects to retrieve.
*/
@Deprecated
Expand Down Expand Up @@ -1657,7 +1664,10 @@ HystrixCommand<SubscriptionList> getSubscriptionsByUser(
* @param after Optional: Cursor for forward pagination; where to start fetching the next set of results in a multi-page response. This applies only to queries without user_id.
* @param limit Optional: Limit the number of items in the response payload. Maximum: 100.
* @return SubscriptionEventList
* @see <a href="https://discuss.dev.twitch.tv/t/deprecation-of-twitch-api-event-endpoints-that-supported-websub-based-webhooks/35137">Deprecation announcement</a>
* @deprecated Will be removed come March 15, 2022, in favor of EventSub and {@link #getSubscriptions(String, String, String, String, Integer)}
*/
@Deprecated
@RequestLine("GET /subscriptions/events?broadcaster_id={broadcaster_id}&id={id}&user_id={user_id}&after={after}&first={first}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<SubscriptionEventList> getSubscriptionEvents(
Expand Down
2 changes: 2 additions & 0 deletions rest-helix/src/test/java/com/github/twitch4j/helix/endpoints/ModerationServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import com.github.twitch4j.helix.domain.BannedUser;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
Expand All @@ -31,6 +32,7 @@ public void getBannedUsers() {
}

@Test
@Disabled
@DisplayName("Get Banned Events")
public void getBannedEvents() {
List<BannedEvent> results = TestUtils.getTwitchHelixClient().getBannedEvents(TestUtils.getCredential().getAccessToken(), TWITCH_USER_ID, null, null, null)
Expand Down