aboutsummaryrefslogtreecommitdiffstats
path: root/com
diff options
context:
space:
mode:
authorPinapelz <donaldshan1@outlook.com>2023-04-07 14:44:40 -0700
committerGitHub <noreply@github.com>2023-04-07 14:44:40 -0700
commitb2f25298426a6475e1776636fd4de0a6f397d486 (patch)
tree6326f697ea6bc7db6a009ab7157791e37cabae9d /com
parent64e166116c2da46ff325f5f78e0c6985ca6a6ac0 (diff)
Add files via upload
Diffstat (limited to 'com')
-rw-r--r--com/pina/Holodex.html2
-rw-r--r--com/pina/HolodexException.html2
-rw-r--r--com/pina/HolodexService.html100
-rw-r--r--com/pina/datatypes/Channel.html2
-rw-r--r--com/pina/datatypes/Comment.html2
-rw-r--r--com/pina/datatypes/SimpleChannel.html2
-rw-r--r--com/pina/datatypes/SimpleVideo.html2
-rw-r--r--com/pina/datatypes/Video.html2
-rw-r--r--com/pina/datatypes/package-summary.html2
-rw-r--r--com/pina/datatypes/package-tree.html2
-rw-r--r--com/pina/package-summary.html2
-rw-r--r--com/pina/package-tree.html2
-rw-r--r--com/pina/query/ChannelQueryBuilder.html2
-rw-r--r--com/pina/query/VideoByVideoIdQueryBuilder.html2
-rw-r--r--com/pina/query/VideoQueryBuilder.html2
-rw-r--r--com/pina/query/VideosByChannelIDQueryBuilder.html2
-rw-r--r--com/pina/query/package-summary.html2
-rw-r--r--com/pina/query/package-tree.html2
18 files changed, 67 insertions, 67 deletions
diff --git a/com/pina/Holodex.html b/com/pina/Holodex.html
index 29dc9f4..0eea87b 100644
--- a/com/pina/Holodex.html
+++ b/com/pina/Holodex.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>Holodex</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/HolodexException.html b/com/pina/HolodexException.html
index c4fe6d9..0683851 100644
--- a/com/pina/HolodexException.html
+++ b/com/pina/HolodexException.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>HolodexException</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/HolodexService.html b/com/pina/HolodexService.html
index 1682214..d23242e 100644
--- a/com/pina/HolodexService.html
+++ b/com/pina/HolodexService.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>HolodexService</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -236,23 +236,23 @@ loadScripts(document, 'script');</script>
<div class="block">/api/v2/live endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>channel_id</code> - the channel id</dd>
-<dd><code>id</code> - the id</dd>
-<dd><code>include</code> - the include</dd>
-<dd><code>lang</code> - the lang</dd>
-<dd><code>limit</code> - the limit</dd>
-<dd><code>maxUpcomingHours</code> - the max upcoming hours</dd>
-<dd><code>mentioned_channel_id</code> - the mentioned channel id</dd>
-<dd><code>offset</code> - the offset</dd>
-<dd><code>order</code> - the order</dd>
-<dd><code>org</code> - the org</dd>
-<dd><code>paginated</code> - the paginated</dd>
-<dd><code>sort</code> - the sort</dd>
-<dd><code>status</code> - the status</dd>
-<dd><code>topic</code> - the topic</dd>
+<dd><code>channel_id</code> - the YouTube channel id</dd>
+<dd><code>id</code> - the YouTube video id</dd>
+<dd><code>include</code> - the include parameters</dd>
+<dd><code>lang</code> - a comma separated String of languages (e.g "en,ja")</dd>
+<dd><code>limit</code> - the limit for the number of results</dd>
+<dd><code>maxUpcomingHours</code> - number of maximum hours to show upcoming videos</dd>
+<dd><code>mentioned_channel_id</code> - the mentioned channel id of a different channel (for collabs)</dd>
+<dd><code>offset</code> - the offset for the number of results</dd>
+<dd><code>order</code> - the order (asc, desc)</dd>
+<dd><code>org</code> - the organization of which to get videos for (e.g. "Hololive")</dd>
+<dd><code>paginated</code> - paginated field</dd>
+<dd><code>sort</code> - sort by returned field (e.g "start_scheduled")</dd>
+<dd><code>status</code> - filter by video status (e.g. "upcoming")</dd>
+<dd><code>topic</code> - filter by type of video (e.g "stream")</dd>
<dd><code>type</code> - the type</dd>
<dt>Returns:</dt>
-<dd>the live videos</dd>
+<dd>a list of SimpleVideo objects</dd>
</dl>
</section>
</li>
@@ -293,23 +293,23 @@ loadScripts(document, 'script');</script>
<div class="block">/api/v2/video endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>channel_id</code> - the channel id</dd>
-<dd><code>id</code> - the id</dd>
-<dd><code>include</code> - the include</dd>
-<dd><code>lang</code> - the lang</dd>
-<dd><code>limit</code> - the limit</dd>
-<dd><code>max_upcoming_hours</code> - the max upcoming hours</dd>
-<dd><code>mentioned_channel_id</code> - the mentioned channel id</dd>
-<dd><code>offset</code> - the offset</dd>
-<dd><code>order</code> - the order</dd>
-<dd><code>org</code> - the org</dd>
-<dd><code>paginated</code> - the paginated</dd>
-<dd><code>sort</code> - the sort</dd>
-<dd><code>status</code> - the status</dd>
-<dd><code>topic</code> - the topic</dd>
+<dd><code>channel_id</code> - the YouTube channel id</dd>
+<dd><code>id</code> - the YouTube video id</dd>
+<dd><code>include</code> - the include parameters comma seperated</dd>
+<dd><code>lang</code> - a comma separated String of languages (e.g "en,ja")</dd>
+<dd><code>limit</code> - the limit for the number of results</dd>
+<dd><code>max_upcoming_hours</code> - number of maximum hours to show upcoming videos</dd>
+<dd><code>mentioned_channel_id</code> - the mentioned channel id of a different channel (for collabs)</dd>
+<dd><code>offset</code> - the offset for the number of results</dd>
+<dd><code>order</code> - the order (asc, desc)</dd>
+<dd><code>org</code> - the organization of which to get videos for (e.g. "Hololive")</dd>
+<dd><code>paginated</code> - paginated field</dd>
+<dd><code>sort</code> - sort by returned field (e.g "start_scheduled")</dd>
+<dd><code>status</code> - filter by video status (e.g. "upcoming")</dd>
+<dd><code>topic</code> - filter by type of video (e.g "stream")</dd>
<dd><code>type</code> - the type</dd>
<dt>Returns:</dt>
-<dd>the videos</dd>
+<dd>a list of Video objects</dd>
</dl>
</section>
</li>
@@ -349,15 +349,15 @@ loadScripts(document, 'script');</script>
<div class="block">/api/v2/channels/{channelID}/{type} endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>channelID</code> - the channel id</dd>
-<dd><code>type</code> - the type</dd>
-<dd><code>include</code> - the include</dd>
-<dd><code>lang</code> - the lang</dd>
-<dd><code>limit</code> - the limit</dd>
-<dd><code>offset</code> - the offset</dd>
-<dd><code>paginated</code> - the paginated</dd>
+<dd><code>channelID</code> - the YouTube channel id</dd>
+<dd><code>type</code> - the type of video resource ("clips", "videos", "collabs")</dd>
+<dd><code>include</code> - the include parameters comma seperated</dd>
+<dd><code>lang</code> - a comma separated String of languages (e.g "en,ja")</dd>
+<dd><code>limit</code> - the limit for the number of results</dd>
+<dd><code>offset</code> - the offset for the number of results</dd>
+<dd><code>paginated</code> - paginated field</dd>
<dt>Returns:</dt>
-<dd>the videos by channel id</dd>
+<dd>list of Videos by channel id</dd>
</dl>
</section>
</li>
@@ -370,7 +370,7 @@ loadScripts(document, 'script');</script>
<div class="block">/api/v2/users/live endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>channels</code> - the channels</dd>
+<dd><code>channels</code> - the channel ids in a comma separated String</dd>
<dt>Returns:</dt>
<dd>the videos from channels</dd>
</dl>
@@ -389,9 +389,9 @@ loadScripts(document, 'script');</script>
<div class="block">/api/v2/videos/{videoID} endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>videoID</code> - the video id</dd>
-<dd><code>lang</code> - the lang</dd>
-<dd><code>c</code> - the c</dd>
+<dd><code>videoID</code> - the YouTube video id</dd>
+<dd><code>lang</code> - a comma separated String of languages (e.g "en,ja")</dd>
+<dd><code>c</code> - 1 will return timestamp comments for the video, 0 will not</dd>
<dt>Returns:</dt>
<dd>the video</dd>
</dl>
@@ -418,13 +418,13 @@ loadScripts(document, 'script');</script>
<div class="block">/api/v2/channels endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
-<dd><code>limit</code> - the limit</dd>
-<dd><code>offset</code> - the offset</dd>
-<dd><code>type</code> - the type</dd>
-<dd><code>lang</code> - the lang</dd>
-<dd><code>order</code> - the order</dd>
-<dd><code>org</code> - the org</dd>
-<dd><code>sort</code> - the sort</dd>
+<dd><code>limit</code> - the limit for the number of results</dd>
+<dd><code>offset</code> - the offset for the number of results</dd>
+<dd><code>type</code> - the type of channel (e.g "vtuber")</dd>
+<dd><code>lang</code> - a comma separated String of languages (e.g "en,ja")</dd>
+<dd><code>order</code> - ascending or descending order (e.g "asc")</dd>
+<dd><code>org</code> - filter by organization (e.g "Hololive")</dd>
+<dd><code>sort</code> - column in which data should be sorted (default is org)</dd>
<dt>Returns:</dt>
<dd>the channels</dd>
</dl>
diff --git a/com/pina/datatypes/Channel.html b/com/pina/datatypes/Channel.html
index db2ee82..8ba553e 100644
--- a/com/pina/datatypes/Channel.html
+++ b/com/pina/datatypes/Channel.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>Channel</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/datatypes/Comment.html b/com/pina/datatypes/Comment.html
index 6a09555..b687be4 100644
--- a/com/pina/datatypes/Comment.html
+++ b/com/pina/datatypes/Comment.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>Comment</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/datatypes/SimpleChannel.html b/com/pina/datatypes/SimpleChannel.html
index 9918590..82fd615 100644
--- a/com/pina/datatypes/SimpleChannel.html
+++ b/com/pina/datatypes/SimpleChannel.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>SimpleChannel</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/datatypes/SimpleVideo.html b/com/pina/datatypes/SimpleVideo.html
index 286e084..2523359 100644
--- a/com/pina/datatypes/SimpleVideo.html
+++ b/com/pina/datatypes/SimpleVideo.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>SimpleVideo</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/datatypes/Video.html b/com/pina/datatypes/Video.html
index 47baffe..6ffd102 100644
--- a/com/pina/datatypes/Video.html
+++ b/com/pina/datatypes/Video.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>Video</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/datatypes/package-summary.html b/com/pina/datatypes/package-summary.html
index b26c729..6acc31c 100644
--- a/com/pina/datatypes/package-summary.html
+++ b/com/pina/datatypes/package-summary.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>com.pina.datatypes</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/datatypes/package-tree.html b/com/pina/datatypes/package-tree.html
index 9465f60..8e9e40d 100644
--- a/com/pina/datatypes/package-tree.html
+++ b/com/pina/datatypes/package-tree.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>com.pina.datatypes Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/package-summary.html b/com/pina/package-summary.html
index dedbff0..cc17c91 100644
--- a/com/pina/package-summary.html
+++ b/com/pina/package-summary.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>com.pina</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/package-tree.html b/com/pina/package-tree.html
index 1765875..da64f17 100644
--- a/com/pina/package-tree.html
+++ b/com/pina/package-tree.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>com.pina Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/query/ChannelQueryBuilder.html b/com/pina/query/ChannelQueryBuilder.html
index c4b29d9..ad1070c 100644
--- a/com/pina/query/ChannelQueryBuilder.html
+++ b/com/pina/query/ChannelQueryBuilder.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>ChannelQueryBuilder</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/query/VideoByVideoIdQueryBuilder.html b/com/pina/query/VideoByVideoIdQueryBuilder.html
index bcfa302..d8bc342 100644
--- a/com/pina/query/VideoByVideoIdQueryBuilder.html
+++ b/com/pina/query/VideoByVideoIdQueryBuilder.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>VideoByVideoIdQueryBuilder</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/query/VideoQueryBuilder.html b/com/pina/query/VideoQueryBuilder.html
index 89d8bc1..de5c543 100644
--- a/com/pina/query/VideoQueryBuilder.html
+++ b/com/pina/query/VideoQueryBuilder.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>VideoQueryBuilder</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/query/VideosByChannelIDQueryBuilder.html b/com/pina/query/VideosByChannelIDQueryBuilder.html
index 5e2077e..4f3605a 100644
--- a/com/pina/query/VideosByChannelIDQueryBuilder.html
+++ b/com/pina/query/VideosByChannelIDQueryBuilder.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>VideosByChannelIDQueryBuilder</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/query/package-summary.html b/com/pina/query/package-summary.html
index 95749b4..ab654c0 100644
--- a/com/pina/query/package-summary.html
+++ b/com/pina/query/package-summary.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>com.pina.query</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
diff --git a/com/pina/query/package-tree.html b/com/pina/query/package-tree.html
index c72ebc7..1b3af30 100644
--- a/com/pina/query/package-tree.html
+++ b/com/pina/query/package-tree.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
-<!-- Generated by javadoc (18) on Fri Apr 07 00:15:53 PDT 2023 -->
+<!-- Generated by javadoc (18) on Fri Apr 07 14:42:16 PDT 2023 -->
<title>com.pina.query Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage