majomi/intro-skipper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Example Plugin project added

Browse Source
This commit is contained in:
Phallacy 2019-02-21 01:57:43 -08:00
parent e2f35ac6cc
commit ea89b92414
4 changed files with 178 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
example-plugin/Configuration/PluginConfiguration.cs Normal file
View File

@ -0,0 +1,24 @@
using MediaBrowser.Model.Plugins;
namespace Jellyfin.Plugin.ExamplePlugin.Configuration
{
public enum SomeOptions
{
OneOption,
AnotherOption
}
public class PluginConfiguration : BasePluginConfiguration
{
//This is where you should store configurable settings your plugin might need.
public bool TrueFalseSetting {get; set;}
public int AnInteger {get; set;}
public string AString {get; set;}
public SomeOptions Options {get; set;}
public PluginConfiguration()
{
Options = SomeOptions.AnotherOption;
TrueFalseSetting = true;
AnInteger = 5;
AString = "This is a string setting";
}
}
}

98
example-plugin/Configuration/configPage.html Normal file
View File

@ -0,0 +1,98 @@
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>ExamplePlugin Configuration</title>
</head>
<body>
<div id="ExamplePluginConfigurationPage" data-role="page" class="page type-interior pluginConfigurationPage" data-require="emby-input,emby-button,emby-select,emby-checkbox">
<div data-role="content">
<div class="content-primary">
<form id="ExamplePluginConfigurationForm">
<div class="selectContainer">
<label class="selectLabel" for="Options">Options:</label>
<select is="emby-select" id="Options" name="Options" class="emby-select-withcolor emby-select">
<option id="optOneOption" value="OneOption">One Option</option>
<option id="optAnotherOption" value="AnotherOption">AnotherOption</option>
</select>
</div>
<div class="inputContainer">
<label class="inputeLabel inputLabelUnfocused" for="AnInteger">An Integer:</label>
<input id="AnInteger" name="AnInteger" type="number" is="emby-input" min="0"/>
<div class="fieldDescription">Numbers go here</div>
</div>
<div class="checkboxContainer checkboxContainer-withDescripton">
<label class="emby-checkbox-label">
<input id="TrueFalseSetting" name="TrueFalseCheckBox" type="checkbox" is="emby-checkbox"/>
<span>True or False</span>
</label>
</div>
<div class="inputContainer">
<label class="inputeLabel inputLabelUnfocused" for="AString">A String:</label>
<input id="AString" name="AString" type="text" is="emby-input" />
<div class="fieldDescription">Words go here</div>
</div>
<div>
<button is="emby-button" type="submit" class="raised button-submit block emby-button">
<span>Save</span>
</button>
</div>
</form>
</div>
</div>
<script type="text/javascript">
var ExamplePluginConfigurationPage =
{
pluginUniqueId: "eb5d7894-8eef-4b36-aa6f-5d124e828ce1",
virtualFolders: [],
physicalFolders: [],
loadConfiguration: function() {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(ExamplePluginConfigurationPage.pluginUniqueId).then(function (config) {
var page = $.mobile.activePage;
$('#Options', page).val(config.Options).change();
$('#AnInteger', page).val(config.AnInteger).change();
$('#TrueFalseSetting', page).checked(config.TrueFalseSetting).checkboxradio("refresh");
$('#AString', page).val(config.AString).change();
Dashboard.hideLoadingMsg();
});
},
saveConfiguration: function() {
Dashboard.showLoadingMsg();
var page = $.mobile.activePage;
ApiClient.getPluginConfiguration(ExamplePluginConfigurationPage.pluginUniqueId).then(function(config) {
config.Options = $('#Options', page).val();
config.AnInteger = $('#AnInteger').val();
config.TrueFalseSetting = $('#TrueFalseSetting').prop('checked');
config.AString = $('#AString').val();
ApiClient.updatePluginConfiguration(ExamplePluginConfigurationPage.pluginUniqueId, config).then(function (result) {
Dashboard.processPluginConfigurationUpdateResult(result);
});
});
},
};
$('#ExamplePluginConfigurationPage').on('pageshow', function () {
ExamplePluginConfigurationPage.loadConfiguration();
});
$('#ExamplePluginConfigurationForm').on('submit', function () {
ExamplePluginConfigurationPage.saveConfiguration();
return false;
});
</script>
</div>
</body>
</html>

35
example-plugin/Plugin.cs Normal file
View File

@ -0,0 +1,35 @@
using System;
using System.Collections.Generic;
using Jellyfin.Plugin.ExamplePlugin.Configuration;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Serialization;
namespace Jellyfin.Plugin.ExamplePlugin
{
public class Plugin : BasePlugin<PluginConfiguration>,
IHasWebPages
{
public override string Name => "ExamplePlugin";
public override Guid Id => Guid.Parse("eb5d7894-8eef-4b36-aa6f-5d124e828ce1");
public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) : base(applicationPaths, xmlSerializer)
{
Instance = this;
}
public static Plugin Instance { get; private set; }
public IEnumerable<PluginPageInfo> GetPages()
{
return new[]
{
new PluginPageInfo
{
Name = this.Name,
EmbeddedResourcePath = string.Format("Jellyfin.Plugin.{0}.Configuration.configPage.html",this.Name)
}
};
}
}
}

21
example-plugin/example-jellyfin-plugin.csproj Normal file
View File

@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<RootNamespace>Jellyfin.Plugin.ExamplePlugin</RootNamespace>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Jellyfin.Controller" Version="10.2.0.1" />
<PackageReference Include="Jellyfin.Model" Version="10.2.0.1" />
</ItemGroup>
<ItemGroup>
<None Remove="Configuration\configPage.html" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="Configuration\configPage.html" />
</ItemGroup>
</Project>