-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathspeeddial.html
196 lines (182 loc) · 7.16 KB
/
speeddial.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
---
layout: default-withsidebar
title: opr.speeddial
support: 15
copyright: opera-ccby
---
<div id="gc-pagecontent">
<div id="toc">
<h2>Contents</h2>
<ol>
<li><a href="speeddial.html#types">Types</a><ol> <li> <a href="speeddial.html#type-SpeedDial">SpeedDial</a> </li> </ol></li>
<li><a href="speeddial.html#methods">Methods</a>
<ol>
<li><a href="speeddial.html#method-get">get</a></li>
<li><a href="speeddial.html#method-update">update</a></li>
</ol>
</li>
</ol>
</div>
<table class="intro">
<tr>
<th scope="col"></th>
<th scope="col"></th>
</tr>
<tr>
<td><strong>Description:</strong></td>
<td>Use the <code>opr.speeddial</code> module to access a Speed Dial entry and update its properties.</td>
</tr>
<tr>
<td><strong>Permissions:</strong></td>
<td><code>"speeddial"</code></td>
</tr>
<tr>
<td><strong>Learn more:</strong></td>
<td><a href="tut_sd_extensions.html">Speed Dial Extensions</a></td>
</tr>
</table>
<div class="api_reference">
<h2 id="types">Types</h2>
<div>
<h3 id="type-SpeedDial">SpeedDial</h3>
<div>
<dt><code class="type_name"> ( object )</code></dt>
<h4 id="SpeedDial-properties">
Properties of <a href="speeddial.html#type-SpeedDial">SpeedDial</a>
</h4>
<dd><dl> <div>
<a name="property-SpeedDial-name"></a>
<dt>
<code class="variable">title</code>
<code class="property">
(
string
)
</code>
</dt>
<dd>
Title of the Speed Dial entry.
</dd>
</div>
<div>
<a name="property-SpeedDial"></a>
<dt>
<code class="variable">url</code>
<code class="property">
(
string
)
</code>
</dt>
<dd>
URL to which the Speed Dial entry points to.
</dd>
</div>
</dl></dd>
</div>
</div>
<h2 id="methods">Methods</h2>
<div>
<h4 id="method-get">get</h4>
<div class="summary lower"><code>
<span>opr.speeddial.get</span>(<span>function <code class="variable">callback</code></span>)
</code></div>
<div class="description">
<p>
Retrieves details about the extension's Speed Dial entry.
</p>
<h4>Parameters</h4>
<dl>
<div>
<a name="property-get-callback"></a>
<dt>
<code class="variable">callback</code>
<code class="property">
(
function
)
</code>
</dt>
</div>
</dl>
<h4>Callback</h4>
<p>
The <em>callback</em> parameter would return an object with the speed dial's title and URL. </p>
<p>For example: <pre class="prettyprint"><code>opr.speeddial.get(function(result) { console.log("The URL is: " + result.url + " and the title is " + result.title); });</code></span></pre></p>
<dl>
<div>
<a name="property-callback-SpeedDial"></a>
<dt>
<code class="variable">SpeedDial</code>
<code class="property">
(
<a href="speeddial.html#type-SpeedDial">SpeedDial</a>
)
</code>
</dt>
</div>
</dl>
</div>
</div>
<div>
<h4 id="method-update">update</h4>
<div class="summary lower"><code>
<span>opr.speeddial.update</span>(<span> <span>object <span class="variable">SpeedDial</span> </span>)
</code></div>
<div class="description">
<p>
Modifies the properties of the Speed Dial entry, namely its URL and Title.
</p>
<h4>Parameters</h4>
<dl>
<div>
<a name="property-update-updateProperties"></a>
<dt>
<code class="variable">SpeedDial</code>
<code class="property">
(
object
)
</code>
</dt>
<dd>
<dl>
<div>
<a name="property-updateProperties-url"></a>
<dt>
<code class="variable">url</code>
<code class="property">
(
<span class="optional">optional</span>
string
)
</code>
</dt>
<dd>
The URL the Speed Dial entry points to.
</dd>
</div>
<div>
<a name="property-updateProperties-active"></a>
<dt>
<code class="variable">title</code>
<code class="property">
(
<span class="optional">optional</span>
string
)
</code>
</dt>
<dd>
The title of the Speed Dial.
</dd>
</div>
</dl>
</dd>
<p>For example: <pre class="prettyprint"><code>opr.speeddial.update({ url: "http://dev.opera.com", title: "Dev Opera" });</code></span></pre></p>
</div>
</dl>
</div>
</div>
</div>
</div>