-
Notifications
You must be signed in to change notification settings - Fork 0
/
global.html
138 lines (131 loc) · 22.8 KB
/
global.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Global</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Body.html">Body</a></div><div class="sidebar-section-children"><a href="CompletedContext.html">CompletedContext</a></div><div class="sidebar-section-children"><a href="HTTPClient.html">HTTPClient</a></div><div class="sidebar-section-children"><a href="Headers.html">Headers</a></div><div class="sidebar-section-children"><a href="Request.html">Request</a></div><div class="sidebar-section-children"><a href="Response.html">Response</a></div><div class="sidebar-section-children"><a href="RewriteContext.html">RewriteContext</a></div><div class="sidebar-section-children"><a href="ScheduleContext.html">ScheduleContext</a></div><div class="sidebar-section-children"><a href="SharedPreferences.html">SharedPreferences</a></div><div class="sidebar-section-children"><a href="URLSearchParams.html">URLSearchParams</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#onRequest">onRequest</a></div><div class="sidebar-section-children"><a href="global.html#onResponse">onResponse</a></div><div class="sidebar-section-children"><a href="global.html#onSchedule">onSchedule</a></div><div class="sidebar-section-children"><a href="global.html#onSessionCompleted">onSessionCompleted</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><article><div class="container-overview"></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="onRequest"><span class="type-signature">(async) </span>onRequest<span class="signature">(context, url, request)</span><span class="type-signature"> → {Promise.<<a href="Request.html">Request</a>>}</span></h3><div class="description">Design for "Rewrite Script". This function is called before the HTTP request is sent to the server. If you do not modify the request, you should delete this function to avoid unnecessary calls.</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type"><a href="RewriteContext.html">RewriteContext</a></span></td><td class="description last">The context object.</td></tr><tr><td class="name"><code>url</code></td><td class="type"><span class="param-type">string</span></td><td class="description last">The URL of the HTTP request.</td></tr><tr><td class="name"><code>request</code></td><td class="type"><span class="param-type"><a href="Request.html">Request</a></span></td><td class="description last">The HTTP request object.</td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">- A promise that resolves when the function execution is completed.</div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<<a href="Request.html">Request</a>></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Examples</strong><div class="rel"><pre class="prettyprint"><code>// modify request body
async function onRequest(context, url, request) {
// parse to Text
var text = request.body.parseText()
console.log(text)
request.body = "this is a replaced request text"
// parse to JSON
var json = request.body.parseJSON()
json["script_json"] = "JSONValue"
request.body = json
// parse to URLSearchParams
var urlencoded = request.body.parseURLSearchParams()
urlencoded.append("script", "parseURLSearchParams")
request.body = urlencoded
// Done
return request;
}</code></pre></div><div class="rel"><pre class="prettyprint"><code>// redirect、modify path、modify queries、modify headers
async function onRequest(context, url, request) {
console.log(url);
// set parameter, you can get it in onResponse
context.parameters["custom"] = "custom parameter on request"
// redirect
request.scheme = "http" // change to https
request.path = "/upload/json" // path change to /upload/json
request.host = "192.168.3.30" // host change to 192.168.3.30
request.port = 6000 // port change to 6000
// change method
request.method = "POST" // change method to POST
// queries operation
// add query
request.queries.append("name", "value1")
// replace or add query
request.queries.set("name", "value2")
// get query with name
request.queries.get("name")
// delete query with name
request.queries.delete("name")
// headers operation
// delete headers named accept
request.headers.delete("accept")
// add name value to headers
request.headers.append("hodor", "custom value")
// print all headers
var headers = ""
request.headers.forEach((value, name) => {
headers = headers + name + ":" + value
});
console.log(headers);
// Done
return request;
}</code></pre></div></div><h3 class="name has-anchor" id="onResponse"><span class="type-signature">(async) </span>onResponse<span class="signature">(context, url, response)</span><span class="type-signature"> → {Promise.<<a href="Response.html">Response</a>>}</span></h3><div class="description">Design for "Rewrite Script". This function is called before the HTTP response is sent to the client. If you do not modify the response, you should delete this function to avoid unnecessary calls.</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type"><a href="RewriteContext.html">RewriteContext</a></span></td><td class="description last">The context object.</td></tr><tr><td class="name"><code>url</code></td><td class="type"><span class="param-type">string</span></td><td class="description last">The URL of the HTTP response.</td></tr><tr><td class="name"><code>response</code></td><td class="type"><span class="param-type"><a href="Response.html">Response</a></span></td><td class="description last">The HTTP response object.</td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">- A promise that resolves when the function execution is completed.</div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<<a href="Response.html">Response</a>></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Examples</strong><div class="rel"><pre class="prettyprint"><code>// response body
async function onResponse(context, url, response) {
// parse to Text
var text = response.body.parseText()
console.log(text)
response.body = "this is a replaced response text"
// parse to JSON
var json = response.body.parseJSON()
json["script_json"] = "JSONValue"
response.body = json
// parse to URLSearchParams
var urlencoded = response.body.parseURLSearchParams()
urlencoded.append("script", "parseURLSearchParams")
response.body = urlencoded
// Done
return response;
}</code></pre></div><div class="rel"><pre class="prettyprint"><code>// code、headers
async function onResponse(context, url, response) {
// get parameters setting in onRequest
console.log(context.parameters["custom"]) // Output "custom parameter on request"
// match url
console.log(url);
// redirect
response.statusCode = 200 // change status to 200
response.statusPrase = "OK" // change statusText to OK
// headers operation
// delete headers named accept
response.headers.delete("accept")
// add name value to headers
response.headers.append("hodor", "custom value")
// print all headers
var headers = ""
response.headers.forEach((value, name) => {
headers = headers + name + ":" + value
});
console.log(headers);
// Done
return response
}</code></pre></div></div><h3 class="name has-anchor" id="onSchedule"><span class="type-signature">(async) </span>onSchedule<span class="signature">(context)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description">Design for "Schedule Script". This function will be called at the scheduled timer trigger time. It is mainly used to perform some scheduled tasks.</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type"><a href="ScheduleContext.html">ScheduleContext</a></span></td><td class="description last">The context object.</td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">- A promise that resolves when the function execution is completed.</div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>async function onSchedule(context) {
/// set custom parameters for next runloop
context.parameters["custom"] = "custom parameters for next runloop";
/// repeatedCount
console.log(`repeatedCount ${context.repeatedCount}`);
/// if repeatedCount is 2, abort schedule
if (context.repeatedCount == 2) {
abort()
}
// you also an use HTTPClient to send request
const rsp = await HTTPClient.get("https://www.apple.com")
let text = rsp.body.parseText()
console.log(text)
}</code></pre></div></div><h3 class="name has-anchor" id="onSessionCompleted"><span class="type-signature">(async) </span>onSessionCompleted<span class="signature">(context, url, request, response)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description">Design for "HTTP Completed Script". This function is called after the HTTP response is returned. It can be used for HTTP data collection.</div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type"><a href="CompletedContext.html">CompletedContext</a></span></td><td class="description last">The context object.</td></tr><tr><td class="name"><code>url</code></td><td class="type"><span class="param-type">string</span></td><td class="description last">The URL of the HTTP request.</td></tr><tr><td class="name"><code>request</code></td><td class="type"><span class="param-type"><a href="Request.html">Request</a></span></td><td class="description last">The HTTP request object.</td></tr><tr><td class="name"><code>response</code></td><td class="type"><span class="param-type"><a href="Response.html">Response</a></span></td><td class="description last">The HTTP response object.</td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc">- A promise that resolves when the function execution is completed.</div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// sample of pass data to local http server
async function onSessionCompleted(context, url, request, response) {
try {
// parse request body to text
var reqText = request.body.parseText();
// parse response body to text
var rspText = response.body.parseText()
var params = {
"body" : { // HTTPClient post body data
"url": url, // request url
"reqHeader": request.headers.encode(), // request headers
"reqText": reqText, // request body
"rspHeader": response.headers.encode(), // response headers
"rspText": rspText, // response body
},
"headers": { // HTTPClient headers
"from": "onSessionCompleted"
},
}
// send http session data to other server
const rsp = await HTTPClient.post("http://192.168.3.30:8000/upload", params)
// parse response body to text and print
let text = rsp.body.parseText()
console.log(text)
} catch(error) {
console.log(error)
}
}</code></pre></div></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Body.html">Body</a></div><div class="sidebar-section-children"><a href="CompletedContext.html">CompletedContext</a></div><div class="sidebar-section-children"><a href="HTTPClient.html">HTTPClient</a></div><div class="sidebar-section-children"><a href="Headers.html">Headers</a></div><div class="sidebar-section-children"><a href="Request.html">Request</a></div><div class="sidebar-section-children"><a href="Response.html">Response</a></div><div class="sidebar-section-children"><a href="RewriteContext.html">RewriteContext</a></div><div class="sidebar-section-children"><a href="ScheduleContext.html">ScheduleContext</a></div><div class="sidebar-section-children"><a href="SharedPreferences.html">SharedPreferences</a></div><div class="sidebar-section-children"><a href="URLSearchParams.html">URLSearchParams</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#onRequest">onRequest</a></div><div class="sidebar-section-children"><a href="global.html#onResponse">onResponse</a></div><div class="sidebar-section-children"><a href="global.html#onSchedule">onSchedule</a></div><div class="sidebar-section-children"><a href="global.html#onSessionCompleted">onSessionCompleted</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>