2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2020-03-21 15:43:05 +01:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2020-03-21 15:43:05 +01:00
< head >
<!-- Generated by javadoc -->
2021-03-10 09:12:21 +01:00
< title > ResourceService (api 5.2-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2020-03-21 15:43:05 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../jquery/jquery-ui.css" title = "Style" >
2020-03-21 15:43:05 +01:00
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< script type = "text/javascript" src = "../../../../../jquery/jszip/dist/jszip.min.js" > < / script >
< script type = "text/javascript" src = "../../../../../jquery/jszip-utils/dist/jszip-utils.min.js" > < / script >
<!-- [if IE]>
< script type = "text/javascript" src = "../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js" > < / script >
<![endif]-->
< script type = "text/javascript" src = "../../../../../jquery/jquery-3.5.1.js" > < / script >
< script type = "text/javascript" src = "../../../../../jquery/jquery-ui.js" > < / script >
2020-03-21 15:43:05 +01:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-03-10 09:12:21 +01:00
parent.document.title="ResourceService (api 5.2-SNAPSHOT API)";
2020-03-21 15:43:05 +01:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"i0":6,"i1":6,"i2":1,"i3":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
2020-03-21 15:43:05 +01:00
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2020-03-21 15:43:05 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2020-03-21 15:43:05 +01:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2020-03-21 15:43:05 +01:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" id = "allclasses_navbar_top" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../allclasses.html" > All Classes< / a > < / li >
< / ul >
< ul class = "navListSearch" >
< li > < label for = "search" > SEARCH:< / label >
< input type = "text" id = "search" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset" value = "reset" disabled = "disabled" >
< / li >
2020-03-21 15:43:05 +01:00
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2020-03-21 15:43:05 +01:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > < a href = "#nested.class.summary" > Nested< / a > | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2020-03-21 15:43:05 +01:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2020-03-21 15:43:05 +01:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.delivery.web< / a > < / div >
2020-03-21 15:43:05 +01:00
< h2 title = "Interface ResourceService" class = "title" > Interface ResourceService< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< pre > public interface < span class = "typeNameLabel" > ResourceService< / span > < / pre >
< div class = "block" > Service for making plugin resources customizable by user or Plan API.< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== NESTED CLASS SUMMARY ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-03-21 15:43:05 +01:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "nested.class.summary" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< h3 > Nested Class Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2020-03-21 15:43:05 +01:00
< caption > < span > Nested Classes< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Interface< / th >
< th class = "colLast" scope = "col" > Description< / th >
2020-03-21 15:43:05 +01:00
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static class < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "ResourceService.Holder.html" title = "class in com.djrapitops.plan.delivery.web" > ResourceService.Holder< / a > < / span > < / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > static class < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "ResourceService.Position.html" title = "enum in com.djrapitops.plan.delivery.web" > ResourceService.Position< / a > < / span > < / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
<!-- ========== METHOD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-03-21 15:43:05 +01:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
< caption > < span id = "t0" class = "activeTableTab" > < span > All Methods< / span > < span class = "tabEnd" > < / span > < / span > < span id = "t1" class = "tableTab" > < span > < a href = "javascript:show(1);" > Static Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t2" class = "tableTab" > < span > < a href = "javascript:show(2);" > Instance Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t3" class = "tableTab" > < span > < a href = "javascript:show(4);" > Abstract Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < / caption >
2020-03-21 15:43:05 +01:00
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i0" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#addScriptsToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)" > addScriptsToResource< / a > < / span > ​ (java.lang.String pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String fileName,
2021-03-10 09:12:21 +01:00
< a href = "ResourceService.Position.html" title = "enum in com.djrapitops.plan.delivery.web" > ResourceService.Position< / a > position,
java.lang.String... jsSrcs)< / code > < / th >
< td class = "colLast" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Add javascript to load in an existing html resource.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#addStylesToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)" > addStylesToResource< / a > < / span > ​ (java.lang.String pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String fileName,
2021-03-10 09:12:21 +01:00
< a href = "ResourceService.Position.html" title = "enum in com.djrapitops.plan.delivery.web" > ResourceService.Position< / a > position,
java.lang.String... cssSrcs)< / code > < / th >
< td class = "colLast" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Add css to load in an existing html resource.< / div >
< / td >
< / tr >
< tr id = "i2" class = "altColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > static < a href = "ResourceService.html" title = "interface in com.djrapitops.plan.delivery.web" > ResourceService< / a > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getInstance()" > getInstance< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i3" class = "rowColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > < a href = "resource/WebResource.html" title = "interface in com.djrapitops.plan.delivery.web.resource" > WebResource< / a > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getResource(java.lang.String,java.lang.String,java.util.function.Supplier)" > getResource< / a > < / span > ​ (java.lang.String pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String fileName,
2021-03-10 09:12:21 +01:00
java.util.function.Supplier< < a href = "resource/WebResource.html" title = "interface in com.djrapitops.plan.delivery.web.resource" > WebResource< / a > > source)< / code > < / th >
< td class = "colLast" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Make one of your web resources customizable by user or Plan API.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-03-21 15:43:05 +01:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "getInstance()" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getInstance< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > static < a href = "ResourceService.html" title = "interface in com.djrapitops.plan.delivery.web" > ResourceService< / a > getInstance()< / pre >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getResource(java.lang.String,java.lang.String,java.util.function.Supplier)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getResource< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > < a href = "resource/WebResource.html" title = "interface in com.djrapitops.plan.delivery.web.resource" > WebResource< / a > getResource​ (java.lang.String pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String fileName,
2021-03-10 09:12:21 +01:00
java.util.function.Supplier< < a href = "resource/WebResource.html" title = "interface in com.djrapitops.plan.delivery.web.resource" > WebResource< / a > > source)< / pre >
2020-03-21 15:43:05 +01:00
< div class = "block" > Make one of your web resources customizable by user or Plan API.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > pluginName< / code > - Name of your plugin (for config purposes)< / dd >
< dd > < code > fileName< / code > - Name of the file (for customization)< / dd >
< dd > < code > source< / code > - Supplier to use to get the original resource, it is assumed that any text based files are encoded in UTF-8.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > Resource of the customized file.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalArgumentException< / code > - If pluginName is empty or null< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If fileName is empty or null< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If source is null< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "addScriptsToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > addScriptsToResource< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > void addScriptsToResource​ (java.lang.String pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String fileName,
2021-03-10 09:12:21 +01:00
< a href = "ResourceService.Position.html" title = "enum in com.djrapitops.plan.delivery.web" > ResourceService.Position< / a > position,
2020-03-21 15:43:05 +01:00
java.lang.String... jsSrcs)< / pre >
< div class = "block" > Add javascript to load in an existing html resource.
< p >
Adds < code > < script src="jsSrc"> < /script> < / code > or multiple to the resource.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > pluginName< / code > - Name of your plugin (for config purposes)< / dd >
< dd > < code > fileName< / code > - Name of the .html file being modified< / dd >
< dd > < code > position< / code > - Where to place the script tag on the page.< / dd >
< dd > < code > jsSrcs< / code > - Source URLs.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalArgumentException< / code > - If pluginName is empty or null< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If fileName is null, empty or does not end with .html< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If position null< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If jsSrcs is empty or null< / dd >
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "addStylesToResource(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.ResourceService.Position,java.lang.String...)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > addStylesToResource< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > void addStylesToResource​ (java.lang.String pluginName,
2020-03-21 15:43:05 +01:00
java.lang.String fileName,
2021-03-10 09:12:21 +01:00
< a href = "ResourceService.Position.html" title = "enum in com.djrapitops.plan.delivery.web" > ResourceService.Position< / a > position,
2020-03-21 15:43:05 +01:00
java.lang.String... cssSrcs)< / pre >
< div class = "block" > Add css to load in an existing html resource.
< p >
Adds < code > < link href="cssSrc" rel="stylesheet"> < /link> < / code > or multiple to the resource.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > pluginName< / code > - Name of your plugin (for config purposes)< / dd >
< dd > < code > fileName< / code > - Name of the .html file being modified< / dd >
< dd > < code > position< / code > - Where to place the link tag on the page.< / dd >
< dd > < code > cssSrcs< / code > - Source URLs.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.IllegalArgumentException< / code > - If pluginName is empty or null< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If fileName is null, empty or does not end with .html< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If position null< / dd >
< dd > < code > java.lang.IllegalArgumentException< / code > - If cssSrcs is empty or null< / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2020-03-21 15:43:05 +01:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2020-03-21 15:43:05 +01:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2020-03-21 15:43:05 +01:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../../index-all.html" > Index< / a > < / li >
< li > < a href = "../../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" id = "allclasses_navbar_bottom" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../allclasses.html" > All Classes< / a > < / li >
2020-03-21 15:43:05 +01:00
< / ul >
< div >
< script type = "text/javascript" > < ! - -
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
< / script >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2020-03-21 15:43:05 +01:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > < a href = "#nested.class.summary" > Nested< / a > | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2020-03-21 15:43:05 +01:00
< / body >
< / html >
