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

docs: improve TwitchHelix#getClips javadoc #731

Merged
merged 3 commits into from Feb 21, 2023
Merged

docs: improve TwitchHelix#getClips javadoc #731

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0a791a
Improve javadoc comment from method getClips
Skillkiller Feb 21, 2023
baa5d32
chore: apply suggestions from code review
iProdigy Feb 21, 2023
cb372e5
chore: add paragraph spacing
iProdigy Feb 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java
View file
Open in desktop
Expand Up @@ -1325,11 +1325,13 @@ HystrixCommand<CreateClipList> createClip(

/**
* Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).
* Using user-token or app-token to increase rate limits.
* <p>
* For clips returned by game_id or broadcaster_id, the list is in descending order by view count.
* For lists returned by id, the list is in the same order as the input IDs.
*
* @param authToken User or App auth Token, for increased rate-limits
* @param broadcasterId ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
* @param gameId ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
* @param authToken User or App access token.
* @param broadcasterId ID of the broadcaster for whom clips are returned.
* @param gameId ID of the game for which clips are returned.
* @param id ID of the clip being queried. Limit: 100.
* @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
* @param before Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
Expand Down