Package com.pinapelz

Interface HolodexService

public interface HolodexService

The interface Holodex service.

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Channel>	getChannel(String channelID)	/api/v2/channels endpoint
retrofit2.Call<List<Channel>>	getChannels(Integer limit, Integer offset, String type, String lang, String order, String org, String sort)	/api/v2/channels endpoint
retrofit2.Call<List<SimpleVideo>>	getLiveVideos(String channel_id, String id, String include, String lang, Integer limit, Integer maxUpcomingHours, String mentioned_channel_id, Integer offset, String order, String org, String paginated, String sort, String status, String topic, String type)	/api/v2/live endpoint
retrofit2.Call<Video>	getVideo(String videoID, String lang, String c)	/api/v2/videos/{videoID} endpoint
retrofit2.Call<List<Video>>	getVideos(String channel_id, String id, String include, String lang, Integer limit, Integer max_upcoming_hours, String mentioned_channel_id, Integer offset, String order, String org, String paginated, String sort, String status, String topic, String type)	/api/v2/video endpoint
retrofit2.Call<List<Video>>	getVideosByChannelId(String channelID, String type, String include, String lang, Integer limit, Integer offset, String paginated)	/api/v2/channels/{channelID}/{type} endpoint
retrofit2.Call<List<Video>>	getVideosFromChannels(String channels)	/api/v2/users/live endpoint
retrofit2.Call<List<SimpleCommentVideo>>	postCommentSearch(okhttp3.RequestBody commentSearchResult)	/api/v2/search/channelSearch endpoint
retrofit2.Call<CommentSearchResult>	postPaginatedCommentSearch(okhttp3.RequestBody commentSearchResult)
retrofit2.Call<VideoSearchResult>	postPaginatedVideoSearch(okhttp3.RequestBody videoSearchResult)
retrofit2.Call<List<SimpleVideo>>	postVideoSearch(okhttp3.RequestBody videoSearchResult)	/api/v2/search/videoSearch endpoint

Method Details

getLiveVideos

@GET("/api/v2/live")
retrofit2.Call<List<SimpleVideo>> getLiveVideos(@Query("channel_id")
 String channel_id,
 @Query("id")
 String id,
 @Query("include")
 String include,
 @Query("lang")
 String lang,
 @Query("limit")
 Integer limit,
 @Query("maxUpcomingHours")
 Integer maxUpcomingHours,
 @Query("mentioned_channel_id")
 String mentioned_channel_id,
 @Query("offset")
 Integer offset,
 @Query("order")
 String order,
 @Query("org")
 String org,
 @Query("paginated")
 String paginated,
 @Query("sort")
 String sort,
 @Query("status")
 String status,
 @Query("topic")
 String topic,
 @Query("type")
 String type)

/api/v2/live endpoint

Parameters:

channel_id - the YouTube channel id

id - the YouTube video id

include - the include parameters

lang - a comma separated String of languages (e.g "en,ja")

limit - the limit for the number of results

maxUpcomingHours - number of maximum hours to show upcoming videos

mentioned_channel_id - the mentioned channel id of a different channel (for collabs)

offset - the offset for the number of results

order - the order (asc, desc)

org - the organization of which to get videos for (e.g. "Hololive")

paginated - paginated field

sort - sort by returned field (e.g "start_scheduled")

status - filter by video status (e.g. "upcoming")

topic - filter by type of video (e.g "stream")

type - the type

Returns:

a list of SimpleVideo objects

getVideos

@GET("/api/v2/videos")
retrofit2.Call<List<Video>> getVideos(@Query("channel_id")
 String channel_id,
 @Query("id")
 String id,
 @Query("include")
 String include,
 @Query("lang")
 String lang,
 @Query("limit")
 Integer limit,
 @Query("max_upcoming_hours")
 Integer max_upcoming_hours,
 @Query("mentioned_channel_id")
 String mentioned_channel_id,
 @Query("offset")
 Integer offset,
 @Query("order")
 String order,
 @Query("org")
 String org,
 @Query("paginated")
 String paginated,
 @Query("sort")
 String sort,
 @Query("status")
 String status,
 @Query("topic")
 String topic,
 @Query("type")
 String type)

/api/v2/video endpoint

Parameters:

channel_id - the YouTube channel id

id - the YouTube video id

include - the include parameters comma seperated

lang - a comma separated String of languages (e.g "en,ja")

limit - the limit for the number of results

max_upcoming_hours - number of maximum hours to show upcoming videos

mentioned_channel_id - the mentioned channel id of a different channel (for collabs)

offset - the offset for the number of results

order - the order (asc, desc)

org - the organization of which to get videos for (e.g. "Hololive")

paginated - paginated field

sort - sort by returned field (e.g "start_scheduled")

status - filter by video status (e.g. "upcoming")

topic - filter by type of video (e.g "stream")

type - the type

Returns:

a list of Video objects

getChannel

@GET("/api/v2/channels/{channelID}")
retrofit2.Call<Channel> getChannel(@Path("channelID")
 String channelID)

/api/v2/channels endpoint

Parameters:

channelID - the channel id

Returns:

the channel

getVideosByChannelId

@GET("/api/v2/channels/{channelID}/{type}")
retrofit2.Call<List<Video>> getVideosByChannelId(@Path("channelID")
 String channelID,
 @Path("type")
 String type,
 @Query("include")
 String include,
 @Query("lang")
 String lang,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @Query("paginated")
 String paginated)

/api/v2/channels/{channelID}/{type} endpoint

Parameters:

channelID - the YouTube channel id

type - the type of video resource ("clips", "videos", "collabs")

include - the include parameters comma seperated

lang - a comma separated String of languages (e.g "en,ja")

limit - the limit for the number of results

offset - the offset for the number of results

paginated - paginated field

Returns:

list of Videos by channel id

getVideosFromChannels

@GET("/api/v2/users/live")
retrofit2.Call<List<Video>> getVideosFromChannels(@Query("channels")
 String channels)

/api/v2/users/live endpoint

Parameters:

channels - the channel ids in a comma separated String

Returns:

the videos from channels

getVideo

@GET("/api/v2/videos/{videoID}")
retrofit2.Call<Video> getVideo(@Path("videoID")
 String videoID,
 @Query("lang")
 String lang,
 @Query("c")
 String c)

/api/v2/videos/{videoID} endpoint

Parameters:

videoID - the YouTube video id

lang - a comma separated String of languages (e.g "en,ja")

c - 1 will return timestamp comments for the video, 0 will not

Returns:

the video

getChannels

@GET("/api/v2/channels")
retrofit2.Call<List<Channel>> getChannels(@Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @Query("type")
 String type,
 @Query("lang")
 String lang,
 @Query("order")
 String order,
 @Query("org")
 String org,
 @Query("sort")
 String sort)

/api/v2/channels endpoint

Parameters:

limit - the limit for the number of results

offset - the offset for the number of results

type - the type of channel (e.g "vtuber")

lang - a comma separated String of languages (e.g "en,ja")

order - ascending or descending order (e.g "asc")

org - filter by organization (e.g "Hololive")

sort - column in which data should be sorted (default is org)

Returns:

the channels

postVideoSearch

@POST("/api/v2/search/videoSearch")
retrofit2.Call<List<SimpleVideo>> postVideoSearch(@Body
 okhttp3.RequestBody videoSearchResult)

/api/v2/search/videoSearch endpoint

Parameters:

videoSearchResult -

Returns:

postPaginatedVideoSearch

@POST("/api/v2/search/videoSearch")
retrofit2.Call<VideoSearchResult> postPaginatedVideoSearch(@Body
 okhttp3.RequestBody videoSearchResult)

postCommentSearch

@POST("/api/v2/search/commentSearch")
retrofit2.Call<List<SimpleCommentVideo>> postCommentSearch(@Body
 okhttp3.RequestBody commentSearchResult)

/api/v2/search/channelSearch endpoint

Parameters:

commentSearchResult -

Returns:

postPaginatedCommentSearch

@POST("/api/v2/search/commentSearch")
retrofit2.Call<CommentSearchResult> postPaginatedCommentSearch(@Body
 okhttp3.RequestBody commentSearchResult)