424 lines
20 KiB
HTML
424 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
<title>jellyfin-roku api docs Source: source/api/baserequest.brs</title>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.dark.css">
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.darkly.css">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="navbar navbar-default navbar-fixed-top ">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<a class="navbar-brand" href="index.html">jellyfin-roku api docs</a>
|
|
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
</div>
|
|
<div class="navbar-collapse collapse" id="topNavigation">
|
|
<ul class="nav navbar-nav">
|
|
|
|
<li class="dropdown">
|
|
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
|
|
<ul class="dropdown-menu ">
|
|
<li><a href="module-AlbumData.html">AlbumData</a></li><li><a href="module-AlbumGrid.html">AlbumGrid</a></li><li><a href="module-AlbumTrackList.html">AlbumTrackList</a></li><li><a href="module-AlbumView.html">AlbumView</a></li><li><a href="module-Alpha.html">Alpha</a></li><li><a href="module-ArtistView.html">ArtistView</a></li><li><a href="module-AudioPlayer.html">AudioPlayer</a></li><li><a href="module-AudioPlayerView.html">AudioPlayerView</a></li><li><a href="module-AudioTrackListItem.html">AudioTrackListItem</a></li><li><a href="module-ButtonGroupHoriz.html">ButtonGroupHoriz</a></li><li><a href="module-ButtonGroupVert.html">ButtonGroupVert</a></li><li><a href="module-ChannelData.html">ChannelData</a></li><li><a href="module-CollectionData.html">CollectionData</a></li><li><a href="module-ConfigData.html">ConfigData</a></li><li><a href="module-ConfigItem.html">ConfigItem</a></li><li><a href="module-ConfigList.html">ConfigList</a></li><li><a href="module-ExtrasItem.html">ExtrasItem</a></li><li><a href="module-ExtrasRowList.html">ExtrasRowList</a></li><li><a href="module-FavoriteItemsTask.html">FavoriteItemsTask</a></li><li><a href="module-FolderData.html">FolderData</a></li><li><a href="module-GetFiltersTask.html">GetFiltersTask</a></li><li><a href="module-GetNextEpisodeTask.html">GetNextEpisodeTask</a></li><li><a href="module-GetPlaybackInfoTask.html">GetPlaybackInfoTask</a></li><li><a href="module-GetShuffleEpisodesTask.html">GetShuffleEpisodesTask</a></li><li><a href="module-GridItem.html">GridItem</a></li><li><a href="module-GridItemSmall.html">GridItemSmall</a></li><li><a href="module-Home.html">Home</a></li><li><a href="module-HomeData.html">HomeData</a></li><li><a href="module-HomeItem.html">HomeItem</a></li><li><a href="module-HomeRows.html">HomeRows</a></li><li><a href="module-IconButton.html">IconButton</a></li><li><a href="module-Image.html">Image</a></li><li><a href="module-ImageData.html">ImageData</a></li><li><a href="module-IntegerKeyboard.html">IntegerKeyboard</a></li><li><a href="module-ItemGrid.html">ItemGrid</a></li><li><a href="module-ItemGridOptions.html">ItemGridOptions</a></li><li><a href="module-Items.html">Items</a></li><li><a href="module-JFButton.html">JFButton</a></li><li><a href="module-JFButtons.html">JFButtons</a></li><li><a href="module-JFGroup.html">JFGroup</a></li><li><a href="module-JFMessageDialog.html">JFMessageDialog</a></li><li><a href="module-JFOverhang.html">JFOverhang</a></li><li><a href="module-JFScene.html">JFScene</a></li><li><a href="module-JFScreen.html">JFScreen</a></li><li><a href="module-JFServer.html">JFServer</a></li><li><a href="module-JFVideo.html">JFVideo</a></li><li><a href="module-ListPoster.html">ListPoster</a></li><li><a href="module-LoadChannelsTask.html">LoadChannelsTask</a></li><li><a href="module-LoadItemsTask.html">LoadItemsTask</a></li><li><a href="module-LoadItemsTask2.html">LoadItemsTask2</a></li><li><a href="module-LoadPhotoTask.html">LoadPhotoTask</a></li><li><a href="module-LoadProgramDetailsTask.html">LoadProgramDetailsTask</a></li><li><a href="module-LoadScreenSaverTimeoutTask.html">LoadScreenSaverTimeoutTask</a></li><li><a href="module-LoadSheduleTask.html">LoadSheduleTask</a></li><li><a href="module-LoadVideoContentTask.html">LoadVideoContentTask</a></li><li><a href="module-LoginScene.html">LoginScene</a></li><li><a href="module-Main.html">Main</a></li><li><a href="module-MovieData.html">MovieData</a></li><li><a href="module-MovieDetails.html">MovieDetails</a></li><li><a href="module-MovieLibraryView.html">MovieLibraryView</a></li><li><a href="module-MovieOptions.html">MovieOptions</a></li><li><a href="module-MusicAlbumData.html">MusicAlbumData</a></li><li><a href="module-MusicAlbumSongListData.html">MusicAlbumSongListData</a></li><li><a href="module-MusicArtistData.html">MusicArtistData</a></li><li><a href="module-MusicArtistGridItem.html">MusicArtistGridItem</a></li><li><a href="module-MusicLibraryView.html">MusicLibraryView</a></li><li><a href="module-MusicSongData.html">MusicSongData</a></li><li><a href="module-OptionNode.html">OptionNode</a></li><li><a href="module-OptionsButton.html">OptionsButton</a></li><li><a href="module-OptionsData.html">OptionsData</a></li><li><a href="module-OptionsSlider.html">OptionsSlider</a></li><li><a href="module-OverviewDialog.html">OverviewDialog</a></li><li><a href="module-PersonData.html">PersonData</a></li><li><a href="module-PersonDetails.html">PersonDetails</a></li><li><a href="module-PhotoData.html">PhotoData</a></li><li><a href="module-PhotoDetails.html">PhotoDetails</a></li><li><a href="module-PlaybackDialog.html">PlaybackDialog</a></li><li><a href="module-PlayedCheckmark.html">PlayedCheckmark</a></li><li><a href="module-PlaylistData.html">PlaylistData</a></li><li><a href="module-PlaylistView.html">PlaylistView</a></li><li><a href="module-PlaystateTask.html">PlaystateTask</a></li><li><a href="module-ProgramDetails.html">ProgramDetails</a></li><li><a href="module-PublicUserData.html">PublicUserData</a></li><li><a href="module-QueueManager.html">QueueManager</a></li><li><a href="module-QuickConnect.html">QuickConnect</a></li><li><a href="module-QuickConnectDialog.html">QuickConnectDialog</a></li><li><a href="module-RadioDialog.html">RadioDialog</a></li><li><a href="module-RecordProgramTask.html">RecordProgramTask</a></li><li><a href="module-SceneManager.html">SceneManager</a></li><li><a href="module-ScheduleProgramData.html">ScheduleProgramData</a></li><li><a href="module-SearchBox.html">SearchBox</a></li><li><a href="module-SearchData.html">SearchData</a></li><li><a href="module-SearchResults.html">SearchResults</a></li><li><a href="module-SearchRow.html">SearchRow</a></li><li><a href="module-SearchTask.html">SearchTask</a></li><li><a href="module-SeriesData.html">SeriesData</a></li><li><a href="module-ServerDiscoveryTask.html">ServerDiscoveryTask</a></li><li><a href="module-SetServerScreen.html">SetServerScreen</a></li><li><a href="module-ShowScenes.html">ShowScenes</a></li><li><a href="module-SlideOutButton.html">SlideOutButton</a></li><li><a href="module-SongItem.html">SongItem</a></li><li><a href="module-Spinner.html">Spinner</a></li><li><a href="module-StandardDialog.html">StandardDialog</a></li><li><a href="module-Subtitles.html">Subtitles</a></li><li><a href="module-TVEpisode.html">TVEpisode</a></li><li><a href="module-TVEpisodeData.html">TVEpisodeData</a></li><li><a href="module-TVEpisodeRow.html">TVEpisodeRow</a></li><li><a href="module-TVEpisodeRowWithOptions.html">TVEpisodeRowWithOptions</a></li><li><a href="module-TVEpisodes.html">TVEpisodes</a></li><li><a href="module-TVListDetails.html">TVListDetails</a></li><li><a href="module-TVListOptions.html">TVListOptions</a></li><li><a href="module-TVSeasonData.html">TVSeasonData</a></li><li><a href="module-TVSeasonRow.html">TVSeasonRow</a></li><li><a href="module-TVShowDescription.html">TVShowDescription</a></li><li><a href="module-TVShowDetails.html">TVShowDetails</a></li><li><a href="module-TextSizeTask.html">TextSizeTask</a></li><li><a href="module-UserData.html">UserData</a></li><li><a href="module-UserItem.html">UserItem</a></li><li><a href="module-UserLibrary.html">UserLibrary</a></li><li><a href="module-UserRow.html">UserRow</a></li><li><a href="module-UserSelect.html">UserSelect</a></li><li><a href="module-VideoData.html">VideoData</a></li><li><a href="module-VideoPlayer.html">VideoPlayer</a></li><li><a href="module-VideoPlayerView.html">VideoPlayerView</a></li><li><a href="module-VideoTrackListItem.html">VideoTrackListItem</a></li><li><a href="module-ViewCreator.html">ViewCreator</a></li><li><a href="module-WhatsNewDialog.html">WhatsNewDialog</a></li><li><a href="module-baserequest.html">baserequest</a></li><li><a href="module-captionTask.html">captionTask</a></li><li><a href="module-config.html">config</a></li><li><a href="module-deviceCapabilities.html">deviceCapabilities</a></li><li><a href="module-globals.html">globals</a></li><li><a href="module-migrations.html">migrations</a></li><li><a href="module-misc.html">misc</a></li><li><a href="module-quickplay.html">quickplay</a></li><li><a href="module-schedule.html">schedule</a></li><li><a href="module-section.html">section</a></li><li><a href="module-sectionScroller.html">sectionScroller</a></li><li><a href="module-settings.html">settings</a></li><li><a href="module-userauth.html">userauth</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<div class="col-sm-3 col-md-3">
|
|
<form class="navbar-form" role="search">
|
|
<div class="input-group">
|
|
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
|
<div class="input-group-btn">
|
|
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="container" id="toc-content">
|
|
<div class="row">
|
|
|
|
|
|
<div class="col-md-12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
<h1 class="page-title">Source: source/api/baserequest.brs</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre
|
|
class="sunlight-highlight-javascript linenums">' Functions for making requests to the API
|
|
function buildParams(params = {} as object) as string
|
|
' Take an object of parameters and construct the URL query
|
|
|
|
param_array = []
|
|
for each field in params.items()
|
|
item = ""
|
|
if type(field.value) = "String" or type(field.value) = "roString"
|
|
item = field.key + "=" + field.value.trim().EncodeUriComponent()
|
|
else if type(field.value) = "roInteger" or type(field.value) = "roInt"
|
|
item = field.key + "=" + stri(field.value).trim()
|
|
'item = field.key + "=" + str(field.value).trim()
|
|
else if type(field.value) = "roFloat"
|
|
item = field.key + "=" + stri(int(field.value)).trim()
|
|
else if type(field.value) = "LongInteger"
|
|
item = field.key + "=" + field.value.toStr().trim()
|
|
else if type(field.value) = "roArray"
|
|
' TODO handle array params
|
|
else if type(field.value) = "roBoolean"
|
|
if field.value
|
|
item = field.key + "=true"
|
|
else
|
|
item = field.key + "=false"
|
|
end if
|
|
else if field.value = invalid
|
|
item = field.key + "=null"
|
|
else if field <> invalid
|
|
print "Unhandled param type: " + type(field.value)
|
|
item = field.key + "=" + field.value.EncodeUriComponent()
|
|
end if
|
|
|
|
if item <> "" then param_array.push(item)
|
|
end for
|
|
|
|
return param_array.join("&")
|
|
end function
|
|
|
|
function buildURL(path as string, params = {} as object) as dynamic
|
|
serverURL = get_url()
|
|
if serverURL = invalid then return invalid
|
|
|
|
' Add intial '/' if path does not start with one
|
|
if path.Left(1) = "/"
|
|
full_url = serverURL + path
|
|
else
|
|
full_url = serverURL + "/" + path
|
|
end if
|
|
|
|
if params.count() > 0
|
|
full_url = full_url + "?" + buildParams(params)
|
|
end if
|
|
|
|
return full_url
|
|
end function
|
|
|
|
function APIRequest(url as string, params = {} as object) as dynamic
|
|
full_url = buildURL(url, params)
|
|
if full_url = invalid then return invalid
|
|
|
|
serverURL = m.global.session.server.url
|
|
if serverURL = invalid then return invalid
|
|
|
|
req = createObject("roUrlTransfer")
|
|
req.setUrl(full_url)
|
|
req = authRequest(req)
|
|
' SSL cert
|
|
if serverURL.left(8) = "https://"
|
|
setCertificateAuthority(req)
|
|
end if
|
|
|
|
return req
|
|
end function
|
|
|
|
function getJson(req)
|
|
'req.retainBodyOnError(True)
|
|
data = req.GetToString()
|
|
if data = invalid or data = ""
|
|
return invalid
|
|
end if
|
|
json = ParseJson(data)
|
|
return json
|
|
end function
|
|
|
|
function postVoid(req, data = "" as string) as boolean
|
|
req.setMessagePort(CreateObject("roMessagePort"))
|
|
req.AddHeader("Content-Type", "application/json")
|
|
req.AsyncPostFromString(data)
|
|
resp = wait(30000, req.GetMessagePort())
|
|
if type(resp) <> "roUrlEvent"
|
|
return false
|
|
end if
|
|
|
|
if resp.GetResponseCode() = 200
|
|
return true
|
|
end if
|
|
|
|
return false
|
|
end function
|
|
|
|
function headVoid(req) as boolean
|
|
req.setMessagePort(CreateObject("roMessagePort"))
|
|
req.AddHeader("Content-Type", "application/json")
|
|
req.AsyncHead()
|
|
resp = wait(30000, req.GetMessagePort())
|
|
if type(resp) <> "roUrlEvent"
|
|
return false
|
|
end if
|
|
|
|
if resp.GetResponseCode() = 200
|
|
return true
|
|
end if
|
|
|
|
return false
|
|
end function
|
|
|
|
function getVoid(req) as boolean
|
|
req.setMessagePort(CreateObject("roMessagePort"))
|
|
req.AddHeader("Content-Type", "application/json")
|
|
req.AsyncGetToString()
|
|
resp = wait(30000, req.GetMessagePort())
|
|
|
|
if type(resp) <> "roUrlEvent"
|
|
return false
|
|
end if
|
|
|
|
if resp.GetResponseCode() = 200
|
|
return true
|
|
end if
|
|
|
|
return false
|
|
end function
|
|
|
|
function postJson(req, data = "" as string)
|
|
req.setMessagePort(CreateObject("roMessagePort"))
|
|
req.AddHeader("Content-Type", "application/json")
|
|
req.AsyncPostFromString(data)
|
|
resp = wait(30000, req.GetMessagePort())
|
|
if type(resp) <> "roUrlEvent"
|
|
return invalid
|
|
end if
|
|
|
|
if resp.getString() = ""
|
|
return invalid
|
|
end if
|
|
|
|
json = ParseJson(resp.GetString())
|
|
|
|
return json
|
|
end function
|
|
|
|
function deleteVoid(req)
|
|
req.setMessagePort(CreateObject("roMessagePort"))
|
|
req.AddHeader("Content-Type", "application/json")
|
|
req.SetRequest("DELETE")
|
|
req.GetToString()
|
|
|
|
return true
|
|
end function
|
|
|
|
function get_url()
|
|
serverURL = m.global.session.server.url
|
|
if serverURL <> invalid
|
|
if serverURL.right(1) = "/"
|
|
serverURL = serverURL.left(serverURL.len() - 1)
|
|
end if
|
|
|
|
' append http:// to the start if not specified
|
|
if serverURL.left(7) <> "http://" and serverURL.left(8) <> "https://"
|
|
serverURL = "http://" + serverURL
|
|
end if
|
|
end if
|
|
return serverURL
|
|
end function
|
|
|
|
function getString(req)
|
|
data = req.GetToString()
|
|
return data
|
|
end function
|
|
|
|
function postString(req, data = "" as string)
|
|
req.setMessagePort(CreateObject("roMessagePort"))
|
|
req.AddHeader("Content-Type", "application/json")
|
|
req.AsyncPostFromString(data)
|
|
resp = wait(30000, req.GetMessagePort())
|
|
if type(resp) <> "roUrlEvent"
|
|
return invalid
|
|
end if
|
|
|
|
return resp.getString()
|
|
end function
|
|
|
|
' sets the certificate authority by file path on the passed node
|
|
sub setCertificateAuthority(request as object) as void
|
|
request.setCertificatesFile("common:/certs/ca-bundle.crt")
|
|
end sub
|
|
|
|
' Takes and returns a roUrlTransfer object after adding a Jellyfin "Authorization" header
|
|
function authRequest(request as object) as object
|
|
QUOTE = Chr(34)
|
|
auth = "MediaBrowser" + " Client=" + QUOTE + "Jellyfin Roku" + QUOTE
|
|
auth = auth + ", Device=" + QUOTE + m.global.device.name + " (" + m.global.device.model + ")" + QUOTE
|
|
auth = auth + ", Version=" + QUOTE + m.global.app.version + QUOTE
|
|
|
|
if m.global.session.user.id <> invalid
|
|
auth = auth + ", UserId=" + QUOTE + m.global.session.user.id + QUOTE
|
|
end if
|
|
|
|
auth = auth + ", DeviceId=" + QUOTE + m.global.device.serverDeviceName + QUOTE
|
|
|
|
if m.global.session.user.authToken <> invalid
|
|
auth = auth + ", Token=" + QUOTE + m.global.session.user.authToken + QUOTE
|
|
end if
|
|
|
|
request.AddHeader("Authorization", auth)
|
|
return request
|
|
end function
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="searchResults">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
|
<h4 class="modal-title">Search results</h4>
|
|
</div>
|
|
<div class="modal-body"></div>
|
|
<div class="modal-footer">
|
|
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
|
</div>
|
|
</div><!-- /.modal-content -->
|
|
</div><!-- /.modal-dialog -->
|
|
</div>
|
|
|
|
|
|
<footer>
|
|
|
|
<span class="jsdoc-message">Source code: <a href="https://github.com/jellyfin/jellyfin-roku">https://github.com/jellyfin/jellyfin-roku</a></span><span class="jsdoc-message">Jellyfin Roku Development Forum: <a href="https://forum.jellyfin.org/f-roku-development">https://forum.jellyfin.org/f-roku-development</a></span>
|
|
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
|
|
|
|
on Nov 8th 2023
|
|
|
|
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
|
</span>
|
|
</footer>
|
|
|
|
<script src="scripts/docstrap.lib.js"></script>
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
|
|
|
|
|
<script>
|
|
$( function () {
|
|
$( "[id*='$']" ).each( function () {
|
|
var $this = $( this );
|
|
|
|
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
|
} );
|
|
|
|
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
|
var $this = $( this );
|
|
|
|
var example = $this.find( "code" );
|
|
exampleText = example.html();
|
|
var lang = /{@lang (.*?)}/.exec( exampleText );
|
|
if ( lang && lang[1] ) {
|
|
exampleText = exampleText.replace( lang[0], "" );
|
|
example.html( exampleText );
|
|
lang = lang[1];
|
|
} else {
|
|
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
|
lang = langClassMatch ? langClassMatch[1] : "javascript";
|
|
}
|
|
|
|
if ( lang ) {
|
|
|
|
$this
|
|
.addClass( "sunlight-highlight-" + lang )
|
|
.addClass( "linenums" )
|
|
.html( example.html() );
|
|
|
|
}
|
|
} );
|
|
|
|
Sunlight.highlightAll( {
|
|
lineNumbers : true,
|
|
showMenu : true,
|
|
enableDoclinks : true
|
|
} );
|
|
|
|
$.catchAnchorLinks( {
|
|
navbarOffset: 10
|
|
} );
|
|
$( "#toc" ).toc( {
|
|
anchorName : function ( i, heading, prefix ) {
|
|
return $( heading ).attr( "id" ) || ( prefix + i );
|
|
},
|
|
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
|
showAndHide : false,
|
|
smoothScrolling: true
|
|
} );
|
|
|
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
|
$( '.dropdown-toggle' ).dropdown();
|
|
|
|
$( "table" ).each( function () {
|
|
var $this = $( this );
|
|
$this.addClass('table');
|
|
} );
|
|
|
|
} );
|
|
</script>
|
|
|
|
|
|
|
|
<!--Navigation and Symbol Display-->
|
|
|
|
|
|
<!--Google Analytics-->
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
SearcherDisplay.init();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html>
|