From 617bfe77d4f92cb754199d292eb0b22e1271e8fc Mon Sep 17 00:00:00 2001 From: jellyfin-bot Date: Tue, 31 Oct 2023 21:36:19 +0000 Subject: [PATCH] Update API docs --- docs/api/module-misc.html | 494 ++++++++++++++++++++----- docs/api/quicksearch.html | 2 +- docs/api/source_ShowScenes.brs.html | 9 +- docs/api/source_utils_globals.brs.html | 2 + docs/api/source_utils_misc.brs.html | 130 +++++-- 5 files changed, 525 insertions(+), 112 deletions(-) diff --git a/docs/api/module-misc.html b/docs/api/module-misc.html index 4fd55bd3e..3b6cd4bae 100644 --- a/docs/api/module-misc.html +++ b/docs/api/module-misc.html @@ -276,7 +276,7 @@
Parameters:
@@ -458,7 +458,7 @@
Parameters:
@@ -814,7 +814,7 @@
Parameters:
@@ -1340,7 +1340,7 @@
Parameters:
@@ -1914,7 +1914,326 @@
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +boolean + + + +
+
+ + + + + + + + + +
+
+

<static> inferServerUrl(url)

+ + +
+
+ + +
+

take an incomplete url string and use it to make educated guesses about
+the complete url. then tests these guesses to see if it can find a jf server
+returns the url of the server it found, or an empty string

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
url + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ + + +
+
+

<static> isJellyfinServer(systemInfo)

+ + +
+
+ + +
+

accepts the raw json string of /system/info/public and returns
+a boolean indicating if ProductName is "Jellyfin Server"

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
systemInfo + + +object + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+
@@ -2072,7 +2391,7 @@
Parameters:
@@ -2408,7 +2727,7 @@
Parameters:
@@ -2567,7 +2886,7 @@
Parameters:
@@ -3408,7 +3727,7 @@

<static>
-

Returns an array from a url - [ url, proto, host, port, subdir/params ]
+

Returns an array from a url = [ url, proto, host, port, subdir+params ]
If port or subdir are not found, an empty string will be added to the array
Proto must be declared or array will be empty

@@ -3507,7 +3826,7 @@

Parameters:
@@ -3665,7 +3984,7 @@
Parameters:
@@ -3997,7 +4316,7 @@
Parameters:
@@ -4406,7 +4725,7 @@
Parameters:
@@ -4459,18 +4778,13 @@
Returns:

-

<static> standardize_jellyfin_url(url)

+

<static> startLoadingSpinner()

-
-

Take a jellyfin hostname and ensure it's a full url.
-prepend http or https and append default ports, and remove excess slashes

-
- @@ -4478,56 +4792,6 @@

< -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
url - - -string - - - - -
- -
@@ -4565,7 +4829,7 @@
Parameters:

@@ -4601,7 +4865,7 @@
Returns:
-dynamic +void @@ -4618,7 +4882,7 @@
Returns:

-

<static> startLoadingSpinner()

+

<static> startMediaLoadingSpinner()

@@ -4669,7 +4933,7 @@

<stat @@ -4722,7 +4986,7 @@
Returns:

-

<static> startMediaLoadingSpinner()

+

<static> stopLoadingSpinner()

@@ -4773,7 +5037,7 @@

< @@ -4826,7 +5090,7 @@
Returns:

-

<static> stopLoadingSpinner()

+

<static> ticksToHuman(ticks)

@@ -4840,6 +5104,56 @@

<stati +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
ticks + + +longinteger + + + + +
+ +
@@ -4877,7 +5191,7 @@

<stati @@ -4913,7 +5227,7 @@
Returns:
-void +string @@ -4930,7 +5244,7 @@
Returns:

-

<static> ticksToHuman(ticks)

+

<static> toString(input)

@@ -4969,13 +5283,13 @@
Parameters:
- ticks + input -longinteger +dynamic @@ -5031,7 +5345,7 @@
Parameters:
@@ -5084,13 +5398,19 @@
Returns:

-

<static> toString(input)

+

<static> urlCandidates(input)

+
+

this is the "educated guess" logic for inferServerUrl that generates a list of complete url's as candidates
+for the tests in inferServerUrl. takes an incomplete url as an arg and returns a list of extrapolated
+full urls.

+
+ @@ -5129,7 +5449,7 @@
Parameters:
-dynamic +string @@ -5185,7 +5505,7 @@
Parameters:
@@ -5221,7 +5541,7 @@
Returns:
-string +dynamic @@ -5368,7 +5688,7 @@
Parameters:
diff --git a/docs/api/quicksearch.html b/docs/api/quicksearch.html index 2e3ac03f8..076ae79a4 100644 --- a/docs/api/quicksearch.html +++ b/docs/api/quicksearch.html @@ -7,7 +7,7 @@