1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (18) on Thu May 04 11:41:22 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">
<meta name="dc.created" content="2023-05-04">
<meta name="description" content="declaration: package: com.pinapelz, interface: HolodexService">
<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>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</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>Constr | </li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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="Interface HolodexService" class="title">Interface HolodexService</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">HolodexService</span></div>
<div class="block">The interface Holodex service.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>retrofit2.Call<<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-tab3"><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-tab3">
<div class="block">/api/v2/channels endpoint</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#getChannels(java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getChannels</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
<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> type,
<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> lang,
<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> order,
<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> org,
<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> sort)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/channels endpoint</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#getLiveVideos(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.Integer,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getLiveVideos</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> channel_id,
<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> id,
<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> include,
<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> lang,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> maxUpcomingHours,
<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> mentioned_channel_id,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
<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> order,
<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> org,
<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> paginated,
<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> sort,
<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> status,
<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> topic,
<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> type)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/live endpoint</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#getVideo(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getVideo</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> videoID,
<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> lang,
<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> c)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/videos/{videoID} endpoint</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#getVideos(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.Integer,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getVideos</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> channel_id,
<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> id,
<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> include,
<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> lang,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> max_upcoming_hours,
<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> mentioned_channel_id,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
<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> order,
<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> org,
<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> paginated,
<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> sort,
<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> status,
<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> topic,
<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> type)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/video endpoint</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#getVideosByChannelId(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)" class="member-name-link">getVideosByChannelId</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,
<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> type,
<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> include,
<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> lang,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
<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> paginated)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/channels/{channelID}/{type} endpoint</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#getVideosFromChannels(java.lang.String)" 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-tab3">
<div class="block">/api/v2/users/live endpoint</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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/SimpleCommentVideo.html" title="class in com.pinapelz.datatypes">SimpleCommentVideo</a>>></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#postCommentSearch(okhttp3.RequestBody)" class="member-name-link">postCommentSearch</a><wbr>(okhttp3.RequestBody commentSearchResult)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/search/channelSearch endpoint</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<a href="datatypes/CommentSearchResult.html" title="class in com.pinapelz.datatypes">CommentSearchResult</a>></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#postPaginatedCommentSearch(okhttp3.RequestBody)" class="member-name-link">postPaginatedCommentSearch</a><wbr>(okhttp3.RequestBody commentSearchResult)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<a href="datatypes/VideoSearchResult.html" title="class in com.pinapelz.datatypes">VideoSearchResult</a>></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#postPaginatedVideoSearch(okhttp3.RequestBody)" class="member-name-link">postPaginatedVideoSearch</a><wbr>(okhttp3.RequestBody videoSearchResult)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>retrofit2.Call<<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-tab3"><code><a href="#postVideoSearch(okhttp3.RequestBody)" class="member-name-link">postVideoSearch</a><wbr>(okhttp3.RequestBody videoSearchResult)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">/api/v2/search/videoSearch endpoint</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getLiveVideos(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.Integer,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
<h3>getLiveVideos</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/live")
</span><span class="return-type">retrofit2.Call<<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">getLiveVideos</span><wbr><span class="parameters">(@Query("channel_id")
<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> channel_id,
@Query("id")
<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> id,
@Query("include")
<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> include,
@Query("lang")
<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> lang,
@Query("limit")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
@Query("maxUpcomingHours")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> maxUpcomingHours,
@Query("mentioned_channel_id")
<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> mentioned_channel_id,
@Query("offset")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
@Query("order")
<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> order,
@Query("org")
<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> org,
@Query("paginated")
<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> paginated,
@Query("sort")
<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> sort,
@Query("status")
<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> status,
@Query("topic")
<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> topic,
@Query("type")
<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> type)</span></div>
<div class="block">/api/v2/live endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<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>a list of SimpleVideo objects</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVideos(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.Integer,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
<h3>getVideos</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/videos")
</span><span class="return-type">retrofit2.Call<<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">(@Query("channel_id")
<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> channel_id,
@Query("id")
<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> id,
@Query("include")
<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> include,
@Query("lang")
<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> lang,
@Query("limit")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
@Query("max_upcoming_hours")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> max_upcoming_hours,
@Query("mentioned_channel_id")
<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> mentioned_channel_id,
@Query("offset")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
@Query("order")
<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> order,
@Query("org")
<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> org,
@Query("paginated")
<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> paginated,
@Query("sort")
<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> sort,
@Query("status")
<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> status,
@Query("topic")
<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> topic,
@Query("type")
<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> type)</span></div>
<div class="block">/api/v2/video endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<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>a list of Video objects</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getChannel(java.lang.String)">
<h3>getChannel</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/channels/{channelID}")
</span><span class="return-type">retrofit2.Call<<a href="datatypes/Channel.html" title="class in com.pinapelz.datatypes">Channel</a>></span> <span class="element-name">getChannel</span><wbr><span class="parameters">(@Path("channelID")
<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></div>
<div class="block">/api/v2/channels endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>channelID</code> - the channel id</dd>
<dt>Returns:</dt>
<dd>the channel</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVideosByChannelId(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)">
<h3>getVideosByChannelId</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/channels/{channelID}/{type}")
</span><span class="return-type">retrofit2.Call<<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">(@Path("channelID")
<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,
@Path("type")
<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> type,
@Query("include")
<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> include,
@Query("lang")
<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> lang,
@Query("limit")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
@Query("offset")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
@Query("paginated")
<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> paginated)</span></div>
<div class="block">/api/v2/channels/{channelID}/{type} endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<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>list of Videos by channel id</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVideosFromChannels(java.lang.String)">
<h3>getVideosFromChannels</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/users/live")
</span><span class="return-type">retrofit2.Call<<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">(@Query("channels")
<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></div>
<div class="block">/api/v2/users/live endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>channels</code> - the channel ids in a comma separated String</dd>
<dt>Returns:</dt>
<dd>the videos from channels</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVideo(java.lang.String,java.lang.String,java.lang.String)">
<h3>getVideo</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/videos/{videoID}")
</span><span class="return-type">retrofit2.Call<<a href="datatypes/Video.html" title="class in com.pinapelz.datatypes">Video</a>></span> <span class="element-name">getVideo</span><wbr><span class="parameters">(@Path("videoID")
<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> videoID,
@Query("lang")
<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> lang,
@Query("c")
<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> c)</span></div>
<div class="block">/api/v2/videos/{videoID} endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<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>
</section>
</li>
<li>
<section class="detail" id="getChannels(java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
<h3>getChannels</h3>
<div class="member-signature"><span class="annotations">@GET("/api/v2/channels")
</span><span class="return-type">retrofit2.Call<<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">(@Query("limit")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> limit,
@Query("offset")
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> offset,
@Query("type")
<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> type,
@Query("lang")
<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> lang,
@Query("order")
<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> order,
@Query("org")
<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> org,
@Query("sort")
<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> sort)</span></div>
<div class="block">/api/v2/channels endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<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>
</section>
</li>
<li>
<section class="detail" id="postVideoSearch(okhttp3.RequestBody)">
<h3>postVideoSearch</h3>
<div class="member-signature"><span class="annotations">@POST("/api/v2/search/videoSearch")
</span><span class="return-type">retrofit2.Call<<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">postVideoSearch</span><wbr><span class="parameters">(@Body
okhttp3.RequestBody videoSearchResult)</span></div>
<div class="block">/api/v2/search/videoSearch endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>videoSearchResult</code> - </dd>
<dt>Returns:</dt>
</dl>
</section>
</li>
<li>
<section class="detail" id="postPaginatedVideoSearch(okhttp3.RequestBody)">
<h3>postPaginatedVideoSearch</h3>
<div class="member-signature"><span class="annotations">@POST("/api/v2/search/videoSearch")
</span><span class="return-type">retrofit2.Call<<a href="datatypes/VideoSearchResult.html" title="class in com.pinapelz.datatypes">VideoSearchResult</a>></span> <span class="element-name">postPaginatedVideoSearch</span><wbr><span class="parameters">(@Body
okhttp3.RequestBody videoSearchResult)</span></div>
</section>
</li>
<li>
<section class="detail" id="postCommentSearch(okhttp3.RequestBody)">
<h3>postCommentSearch</h3>
<div class="member-signature"><span class="annotations">@POST("/api/v2/search/commentSearch")
</span><span class="return-type">retrofit2.Call<<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/SimpleCommentVideo.html" title="class in com.pinapelz.datatypes">SimpleCommentVideo</a>>></span> <span class="element-name">postCommentSearch</span><wbr><span class="parameters">(@Body
okhttp3.RequestBody commentSearchResult)</span></div>
<div class="block">/api/v2/search/channelSearch endpoint</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>commentSearchResult</code> - </dd>
<dt>Returns:</dt>
</dl>
</section>
</li>
<li>
<section class="detail" id="postPaginatedCommentSearch(okhttp3.RequestBody)">
<h3>postPaginatedCommentSearch</h3>
<div class="member-signature"><span class="annotations">@POST("/api/v2/search/commentSearch")
</span><span class="return-type">retrofit2.Call<<a href="datatypes/CommentSearchResult.html" title="class in com.pinapelz.datatypes">CommentSearchResult</a>></span> <span class="element-name">postPaginatedCommentSearch</span><wbr><span class="parameters">(@Body
okhttp3.RequestBody commentSearchResult)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
|
