diff options
Diffstat (limited to 'com/pinapelz/Holodex.html')
| -rw-r--r-- | com/pinapelz/Holodex.html | 395 |
1 files changed, 395 insertions, 0 deletions
diff --git a/com/pinapelz/Holodex.html b/com/pinapelz/Holodex.html new file mode 100644 index 0000000..690bc20 --- /dev/null +++ b/com/pinapelz/Holodex.html @@ -0,0 +1,395 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (18) on Thu May 04 11:41:22 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"> +<meta name="dc.created" content="2023-05-04"> +<meta name="description" content="declaration: package: com.pinapelz, class: Holodex"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../script.js"></script> +<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script> +<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../index-files/index-1.html">Index</a></li> +<li><a href="../../help-doc.html#class">Help</a></li> +</ul> +<ul class="sub-nav-list-small"> +<li> +<p>Summary:</p> +<ul> +<li>Nested</li> +<li>Field</li> +<li><a href="#constructor-summary">Constr</a></li> +<li><a href="#method-summary">Method</a></li> +</ul> +</li> +<li> +<p>Detail:</p> +<ul> +<li>Field</li> +<li><a href="#constructor-detail">Constr</a></li> +<li><a href="#method-detail">Method</a></li> +</ul> +</li> +</ul> +</div> +<div class="sub-nav"> +<div id="navbar-sub-list"> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" disabled placeholder="Search"> +<input type="reset" id="reset-button" disabled value="reset"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.pinapelz</a></div> +<h1 title="Class Holodex" class="title">Class Holodex</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">com.pinapelz.Holodex</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Holodex</span> +<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> +<div class="block">The class for interacting with the Holodex API</div> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">Holodex</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiKey)</code></div> +<div class="col-last even-row-color"> +<div class="block">Instantiates a new Holodex with the default base url</div> +</div> +<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">Holodex</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiKey, + <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> baseUrl)</code></div> +<div class="col-last odd-row-color"> +<div class="block">Instantiates a new Holodex with a custom base url</div> +</div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel"> +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="datatypes/Channel.html" title="class in com.pinapelz.datatypes">Channel</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChannel(java.lang.String)" class="member-name-link">getChannel</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> channelId)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets information about a channel when given a channel id</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Channel.html" title="class in com.pinapelz.datatypes">Channel</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChannels(com.pinapelz.query.ChannelQueryBuilder)" class="member-name-link">getChannels</a><wbr>(<a href="query/ChannelQueryBuilder.html" title="class in com.pinapelz.query">ChannelQueryBuilder</a> query)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a list of channels the match the ChannelQueryBuilder attributes</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/SimpleVideo.html" title="class in com.pinapelz.datatypes">SimpleVideo</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLiveAndUpcomingVideos(com.pinapelz.query.VideoQueryBuilder)" class="member-name-link">getLiveAndUpcomingVideos</a><wbr>(<a href="query/VideoQueryBuilder.html" title="class in com.pinapelz.query">VideoQueryBuilder</a> queryBuilder)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a list of upcoming and/or live SimpleVideos matching the VideoQueryBuilder attributes</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVideo(com.pinapelz.query.VideoByVideoIdQueryBuilder)" class="member-name-link">getVideo</a><wbr>(<a href="query/VideoByVideoIdQueryBuilder.html" title="class in com.pinapelz.query">VideoByVideoIdQueryBuilder</a> query)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the video matching the VideoByVideoIdQueryBuilder attributes</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVideos(com.pinapelz.query.VideoQueryBuilder)" class="member-name-link">getVideos</a><wbr>(<a href="query/VideoQueryBuilder.html" title="class in com.pinapelz.query">VideoQueryBuilder</a> queryBuilder)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a list of videos matching the VideoQueryBuilder attributes</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVideosByChannelId(com.pinapelz.query.VideosByChannelIDQueryBuilder)" class="member-name-link">getVideosByChannelId</a><wbr>(<a href="query/VideosByChannelIDQueryBuilder.html" title="class in com.pinapelz.query">VideosByChannelIDQueryBuilder</a> query)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets a list of Videos matching the VideoByVideoIdQueryBuilder attributes for a specific channel + Used for when the channel id is known</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVideosFromChannels(java.lang.String%5B%5D)" class="member-name-link">getVideosFromChannels</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] channels)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets upcoming and live videos from an array of channel ids + Response will contain videos from all channels together + This should be used when there is a set of channels that need to be queried</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#searchComment(com.pinapelz.query.CommentSearchQueryBuilder)" class="member-name-link">searchComment</a><wbr>(<a href="query/CommentSearchQueryBuilder.html" title="class in com.pinapelz.query">CommentSearchQueryBuilder</a> query)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sends a POST request to search for comments matching the CommentSearchQueryBuilder attributes + If the query is paginated, the response will be a CommentSearchResult object + If the query is not paginated, the response will be a list of SimpleCommentVideo objects</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#searchVideo(com.pinapelz.query.VideoSearchQueryBuilder)" class="member-name-link">searchVideo</a><wbr>(<a href="query/VideoSearchQueryBuilder.html" title="class in com.pinapelz.query">VideoSearchQueryBuilder</a> query)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sends a POST request to search for videos matching the VideoSearchQueryBuilder attributes + If the query is paginated, the response will be a VideoSearchResult object + If the query is not paginated, the response will be a list of SimpleVideo objects</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>(java.lang.String)"> +<h3>Holodex</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Holodex</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiKey)</span></div> +<div class="block">Instantiates a new Holodex with the default base url</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>apiKey</code> - the api key</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="<init>(java.lang.String,java.lang.String)"> +<h3>Holodex</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Holodex</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiKey, + <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> baseUrl)</span></div> +<div class="block">Instantiates a new Holodex with a custom base url</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>apiKey</code> - the api key</dd> +<dd><code>baseUrl</code> - the base url</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="getLiveAndUpcomingVideos(com.pinapelz.query.VideoQueryBuilder)"> +<h3>getLiveAndUpcomingVideos</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/SimpleVideo.html" title="class in com.pinapelz.datatypes">SimpleVideo</a>></span> <span class="element-name">getLiveAndUpcomingVideos</span><wbr><span class="parameters">(<a href="query/VideoQueryBuilder.html" title="class in com.pinapelz.query">VideoQueryBuilder</a> queryBuilder)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets a list of upcoming and/or live SimpleVideos matching the VideoQueryBuilder attributes</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>queryBuilder</code> - the query builder</dd> +<dt>Returns:</dt> +<dd>A list of upcoming and/or live SimpleVideos</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - the holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getVideos(com.pinapelz.query.VideoQueryBuilder)"> +<h3>getVideos</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></span> <span class="element-name">getVideos</span><wbr><span class="parameters">(<a href="query/VideoQueryBuilder.html" title="class in com.pinapelz.query">VideoQueryBuilder</a> queryBuilder)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets a list of videos matching the VideoQueryBuilder attributes</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>queryBuilder</code> - the query builder</dd> +<dt>Returns:</dt> +<dd>list of videos</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - the holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getChannel(java.lang.String)"> +<h3>getChannel</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="datatypes/Channel.html" title="class in com.pinapelz.datatypes">Channel</a></span> <span class="element-name">getChannel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> channelId)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets information about a channel when given a channel id</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>channelId</code> - the channel id</dd> +<dt>Returns:</dt> +<dd>the Channel</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - the holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getVideosByChannelId(com.pinapelz.query.VideosByChannelIDQueryBuilder)"> +<h3>getVideosByChannelId</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></span> <span class="element-name">getVideosByChannelId</span><wbr><span class="parameters">(<a href="query/VideosByChannelIDQueryBuilder.html" title="class in com.pinapelz.query">VideosByChannelIDQueryBuilder</a> query)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets a list of Videos matching the VideoByVideoIdQueryBuilder attributes for a specific channel + Used for when the channel id is known</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>query</code> - the query</dd> +<dt>Returns:</dt> +<dd>List of videos matching the query</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - the holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getVideosFromChannels(java.lang.String[])"> +<h3>getVideosFromChannels</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></span> <span class="element-name">getVideosFromChannels</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[] channels)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets upcoming and live videos from an array of channel ids + Response will contain videos from all channels together + This should be used when there is a set of channels that need to be queried</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>channels</code> - the channel ids to get videos from</dd> +<dt>Returns:</dt> +<dd>List of live and/or upcoming videos where the channel id is the author</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - the holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getVideo(com.pinapelz.query.VideoByVideoIdQueryBuilder)"> +<h3>getVideo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a></span> <span class="element-name">getVideo</span><wbr><span class="parameters">(<a href="query/VideoByVideoIdQueryBuilder.html" title="class in com.pinapelz.query">VideoByVideoIdQueryBuilder</a> query)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets the video matching the VideoByVideoIdQueryBuilder attributes</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>query</code> - the query</dd> +<dt>Returns:</dt> +<dd>Video matching the query</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getChannels(com.pinapelz.query.ChannelQueryBuilder)"> +<h3>getChannels</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="datatypes/Channel.html" title="class in com.pinapelz.datatypes">Channel</a>></span> <span class="element-name">getChannels</span><wbr><span class="parameters">(<a href="query/ChannelQueryBuilder.html" title="class in com.pinapelz.query">ChannelQueryBuilder</a> query)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Gets a list of channels the match the ChannelQueryBuilder attributes</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>query</code> - the query</dd> +<dt>Returns:</dt> +<dd>List of channels matching the query</dd> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code> - the holodex exception</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="searchVideo(com.pinapelz.query.VideoSearchQueryBuilder)"> +<h3>searchVideo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">searchVideo</span><wbr><span class="parameters">(<a href="query/VideoSearchQueryBuilder.html" title="class in com.pinapelz.query">VideoSearchQueryBuilder</a> query)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Sends a POST request to search for videos matching the VideoSearchQueryBuilder attributes + If the query is paginated, the response will be a VideoSearchResult object + If the query is not paginated, the response will be a list of SimpleVideo objects</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>query</code> - </dd> +<dt>Returns:</dt> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="searchComment(com.pinapelz.query.CommentSearchQueryBuilder)"> +<h3>searchComment</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">searchComment</span><wbr><span class="parameters">(<a href="query/CommentSearchQueryBuilder.html" title="class in com.pinapelz.query">CommentSearchQueryBuilder</a> query)</span> + throws <span class="exceptions"><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></span></div> +<div class="block">Sends a POST request to search for comments matching the CommentSearchQueryBuilder attributes + If the query is paginated, the response will be a CommentSearchResult object + If the query is not paginated, the response will be a list of SimpleCommentVideo objects</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>query</code> - </dd> +<dt>Returns:</dt> +<dt>Throws:</dt> +<dd><code><a href="HolodexException.html" title="class in com.pinapelz">HolodexException</a></code></dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +</div> +</div> +</body> +</html> |