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.

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

docs: update soundtrack api javadoc by twitch revision #534

Merged
merged 1 commit into from Feb 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Expand Up @@ -586,7 +586,7 @@ HystrixCommand<CategorySearchList> searchCategories(
* Gets channel information for users
*
* @param authToken Auth Token
* @param broadcasterIds IDs of the channels to be retrieved
* @param broadcasterIds IDs of the channels to be retrieved (up to 100)
* @return ChannelInformationList
*/
@RequestLine("GET /channels?broadcaster_id={broadcaster_id}")
Expand Down Expand Up @@ -637,6 +637,8 @@ HystrixCommand<ChannelSearchList> searchChannels(

/**
* Gets the Soundtrack track that the broadcaster is playing.
* <p>
* If the broadcaster is not playing a track, the endpoint returns HTTP status code 404 Not Found.
*
* @param authToken App access token or User access token.
* @param broadcasterId The ID of the broadcaster that’s playing a Soundtrack track.
Expand Down
Expand Up @@ -3,17 +3,15 @@
import lombok.AccessLevel;
import lombok.Data;
import lombok.Setter;
import org.jetbrains.annotations.Nullable;

@Data
@Setter(AccessLevel.PRIVATE)
public class SoundtrackArtist {

/**
* The ID of the Twitch user that created the track.
* Is null if a Twitch user didn't create the track.
* Is an empty string if a Twitch user didn't create the track.
*/
@Nullable
private String creatorChannelId;

/**
Expand Down
Expand Up @@ -13,12 +13,11 @@ public class SoundtrackCurrentTrackWrapper {

/**
* A list that contains the Soundtrack track that the broadcaster is playing.
* The list is empty if the broadcaster is not playing a track.
*/
private List<SoundtrackCurrentTrack> data;

/**
* @return the Soundtrack track that the broadcaster is playing or empty if the broadcaster is not playing a track.
* @return the Soundtrack track that the broadcaster is playing.
*/
public Optional<SoundtrackCurrentTrack> getTrack() {
if (data == null || data.isEmpty())
Expand Down