Package com.pina

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

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 channel id

id - the id

include - the include

lang - the lang

limit - the limit

maxUpcomingHours - the max upcoming hours

mentioned_channel_id - the mentioned channel id

offset - the offset

order - the order

org - the org

paginated - the paginated

sort - the sort

status - the status

topic - the topic

type - the type

Returns:

the live videos

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 channel id

id - the id

include - the include

lang - the lang

limit - the limit

max_upcoming_hours - the max upcoming hours

mentioned_channel_id - the mentioned channel id

offset - the offset

order - the order

org - the org

paginated - the paginated

sort - the sort

status - the status

topic - the topic

type - the type

Returns:

the videos

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 channel id

type - the type

include - the include

lang - the lang

limit - the limit

offset - the offset

paginated - the paginated

Returns:

the 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 channels

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 video id

lang - the lang

c - the c

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

offset - the offset

type - the type

lang - the lang

order - the order

org - the org

sort - the sort

Returns:

the channels