@gkd-kit/docs 0.0.1720886783570 → 0.0.1720963467418

package/.vitepress/dist/assets/api_interfaces_RawSubscription.md.CJdX8Xim.js

@@ -1,4 +0,0 @@
-import{_ as a,c as e,o,a4 as t}from"./chunks/framework.B8qPA-ia.js";const b=JSON.parse('{"title":"RawSubscription","description":"","frontmatter":{},"headers":[],"relativePath":"api/interfaces/RawSubscription.md","filePath":"api/interfaces/RawSubscription.md","lastUpdated":null}'),r={name:"api/interfaces/RawSubscription.md"},s=t(`<h1 id="rawsubscription" tabindex="-1">RawSubscription <a class="header-anchor" href="#rawsubscription" aria-label="Permalink to &quot;RawSubscription&quot;">​</a></h1><p>订阅配置类型</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;">​</a></h3><blockquote><p><strong>id</strong>: <a href="./../type-aliases/Integer.html"><code>Integer</code></a></p></blockquote><p>当前订阅文件的标识, 如果新旧订阅文件id不一致则更新失败</p><p>负数 id 被 GKD 内部使用, 用户无法添加负数 id 的订阅</p><hr><h3 id="name" tabindex="-1">name <a class="header-anchor" href="#name" aria-label="Permalink to &quot;name&quot;">​</a></h3><blockquote><p><strong>name</strong>: <code>string</code></p></blockquote><p>订阅的名称</p><hr><h3 id="version" tabindex="-1">version <a class="header-anchor" href="#version" aria-label="Permalink to &quot;version&quot;">​</a></h3><blockquote><p><strong>version</strong>: <a href="./../type-aliases/Integer.html"><code>Integer</code></a></p></blockquote><p>订阅的版本号, 用于检测更新</p><p>只有当新订阅的 version 大于本地旧订阅的 version 才执行更新替换本地</p><hr><h3 id="author" tabindex="-1">author? <a class="header-anchor" href="#author" aria-label="Permalink to &quot;author?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>author</strong>: <code>string</code></p></blockquote><p>作者名称</p><hr><h3 id="updateurl" tabindex="-1">updateUrl? <a class="header-anchor" href="#updateurl" aria-label="Permalink to &quot;updateUrl?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>updateUrl</strong>: <code>string</code></p></blockquote><p>GKD 会定时或者用户手动刷新请求这个链接, 如果返回的订阅的 version 大于应用订阅当前的 version , 则更新</p><p>如果这个字段不存在, 则使用添加订阅时填写的链接</p><hr><h3 id="supporturi" tabindex="-1">supportUri? <a class="header-anchor" href="#supporturi" aria-label="Permalink to &quot;supportUri?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>supportUri</strong>: <code>string</code></p></blockquote><p>一个自定义 uri 链接, 用户点击[用户反馈]时, 打开此链接</p><p>可以是一个网页链接, 也可以是一个应用内部的 uri 链接</p><hr><h3 id="checkupdateurl" tabindex="-1">checkUpdateUrl? <a class="header-anchor" href="#checkupdateurl" aria-label="Permalink to &quot;checkUpdateUrl?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>checkUpdateUrl</strong>: <code>string</code></p></blockquote><p>一个只需要 id 和 version 的 json5 文件链接, 检测更新时, 优先检测此链接, 如果 id 相等并且 version 增加, 则再去请求 updateUrl</p><p>目的是防止订阅文件过大而消耗过多的流量, 如下是一个简单的示例</p><div class="language-json5 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json5</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
-<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">  id</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">114514</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
-<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">  version</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1919810</span></span>
-<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>支持相对地址, 如果 <a href="./RawSubscription.html#updateurl">updateUrl</a> 或者用户添加订阅时填写的链接是 <code>https://gkd.li/gkd.json5</code> 并且 <a href="./RawSubscription.html#checkupdateurl">checkUpdateUrl</a> 是 <code>./gkd.version.json5</code></p><p>那么最终请求的链接是 <code>https://gkd.li/gkd.version.json5</code></p><hr><h3 id="apps" tabindex="-1">apps? <a class="header-anchor" href="#apps" aria-label="Permalink to &quot;apps?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>apps</strong>: <a href="./RawApp.html"><code>RawApp</code></a>[]</p></blockquote><p>此订阅的应用列表</p><hr><h3 id="globalgroups" tabindex="-1">globalGroups? <a class="header-anchor" href="#globalgroups" aria-label="Permalink to &quot;globalGroups?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>globalGroups</strong>: <a href="./RawGlobalGroup.html"><code>RawGlobalGroup</code></a>[]</p></blockquote><p>此订阅的全局规则组列表</p><hr><h3 id="categories" tabindex="-1">categories? <a class="header-anchor" href="#categories" aria-label="Permalink to &quot;categories?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>categories</strong>: <a href="./RawCategory.html"><code>RawCategory</code></a>[]</p></blockquote><p>此订阅的应用规则分类列表</p>`,50),i=[s];function p(n,l,c,d,h,u){return o(),e("div",null,i)}const g=a(r,[["render",p]]);export{b as __pageData,g as default};