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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
|
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
<!ENTITY ERROR_PERMISSION_DENIED "org.freedesktop.Hostname1.Error.PermissionDenied">
<!ENTITY ERROR_INVALID_DATA "org.freedesktop.Hostname1.Error.InvalidData">
<!ENTITY ERROR_FAILED "org.freedesktop.Hostname1.Error.Failed">
<!ENTITY ERROR_HAS_TRANSIENT_DATA_PROVIDER "org.freedesktop.Hostname1.Error.HasTransientDataProvider">
]>
<node name="/hostname1" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.Hostname1">
<doc:doc>
<doc:description>
<doc:para>
This interface is usually implemented by the object
<doc:tt>/org/freedesktop/hostname1</doc:tt>
exported by a system D-Bus service with the well-known name
<doc:tt>org.freedesktop.Hostname1</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<!-- ******************************************************************************** -->
<method name="SetDisplayHostname">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:configured-display-hostname">configured-display-hostname</doc:ref>
property.
Typically only user interface applications will call this method in response to an user initiated action.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.hostname1.change</doc:term>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller is not authorized</doc:error>
<doc:error name="&ERROR_INVALID_DATA;">if invalid data is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="display_hostname" direction="in" type="s">
<doc:doc>
<doc:summary>
The value for the display host name.
The passed in value is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:display-hostname">display-hostname</doc:ref>
property.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="SetHostname">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:configured-hostname">configured-hostname</doc:ref>
property.
Typically only user interface applications will call this method in response to an user initiated action.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.hostname1.change</doc:term>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller is not authorized</doc:error>
<doc:error name="&ERROR_INVALID_DATA;">if invalid data is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="hostname" direction="in" type="s">
<doc:doc>
<doc:summary>
The value for the host name.
The passed in value is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:hostname">hostname</doc:ref>
property.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="SetIconName">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:configured-icon-name">configured-icon-name</doc:ref>
property.
Typically only user interface applications will call this method in response to an user initiated action.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.hostname1.change</doc:term>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller is not authorized</doc:error>
<doc:error name="&ERROR_INVALID_DATA;">if invalid data is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="icon_name" direction="in" type="s">
<doc:doc>
<doc:summary>
The name for the host icon.
The passed in value is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:icon-name">icon-name</doc:ref>
property.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="SetUseTransientData">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:use-transient-data">use-transient-data</doc:ref>
property.
Typically only user interface applications will call this method in response to an user initiated action.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.hostname1.change</doc:term>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller is not authorized</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="use_transient_data" direction="in" type="b">
<doc:doc>
<doc:summary>
Whether transient data should be used if available. See the
<doc:ref type="property" to="Hostname1:use-transient-data">use-transient</doc:ref>
property for details.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="RegisterTransientDataProvider">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Registers a provider for transient hostname data. A cookie
is returned that the provider can use for invoking methods like
<doc:ref type="method" to="Hostname1.SetTransientHostname">SetTransientHostname()</doc:ref>
to set transient data. The data is kept in memory and will be purged
when the provider calls
<doc:ref type="method" to="Hostname1.UnregisterTransientDataProvider">UnregisterTransientDataProvider()</doc:ref>
or disconnects from the system message bus.
Only a single client can provide transient hostname data at a time.
Typically only network configuration tools will need to
call this method.
</doc:para>
</doc:description>
<doc:permission>
Only the super user (<doc:tt>uid 0</doc:tt>) can invoke this method.
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_HAS_TRANSIENT_DATA_PROVIDER;">if another client has already registered for providing transient data</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="cookie" direction="out" type="s">
<doc:doc>
<doc:summary>
A cookie to be used for providing transient data via methods such as
<doc:ref type="method" to="Hostname1.SetTransientHostname">SetTransientHostname()</doc:ref>
and to unregister as a transient data provider via the
<doc:ref type="method" to="Hostname1.UnregisterTransientDataProvider">UnregisterTransientDataProvider()</doc:ref>
method.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="UnregisterTransientDataProvider">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Unregisters a transient data provider previously registered with
<doc:ref type="method" to="Hostname1.RegisterTransientDataProvider">RegisterTransientDataProvider()</doc:ref>.
</doc:para>
</doc:description>
<doc:permission>
Only the super user (<doc:tt>uid 0</doc:tt>) can invoke this method.
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_INVALID_DATA;">if an invalid cookie is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="cookie" direction="in" type="s">
<doc:doc>
<doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Hostname1.RegisterTransientDataProvider">RegisterTransientDataProvider()</doc:ref>
method.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="SetTransientDisplayHostname">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:transient-display-hostname">transient-display-hostname</doc:ref>
property.
Typically only network configuration tools will need to
call this method.
</doc:para>
</doc:description>
<doc:permission>
Only the super user (<doc:tt>uid 0</doc:tt>) can invoke this method.
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_INVALID_DATA;">if invalid data is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="cookie" direction="in" type="s">
<doc:doc>
<doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Hostname1.RegisterTransientDataProvider">RegisterTransientDataProvider()</doc:ref>
method.
</doc:summary>
</doc:doc>
</arg>
<arg name="display_hostname" direction="in" type="s">
<doc:doc>
<doc:summary>
The value for the display host name. Any valid UTF-8 string can be used.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="SetTransientHostname">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:transient-hostname">transient-hostname</doc:ref>
property.
Typically only network configuration tools will need to
call this method.
</doc:para>
</doc:description>
<doc:permission>
Only the super user (<doc:tt>uid 0</doc:tt>) can invoke this method.
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_INVALID_DATA;">if invalid data is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="cookie" direction="in" type="s">
<doc:doc>
<doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Hostname1.RegisterTransientDataProvider">RegisterTransientDataProvider()</doc:ref>
method.
</doc:summary>
</doc:doc>
</arg>
<arg name="hostname" direction="in" type="s">
<doc:doc>
<doc:summary>
The value for the host name. Can't be an empty string. Must conform to
limitations and constraints as described for the
<doc:ref type="property" to="Hostname1:hostname">hostname</doc:ref>
property.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<method name="SetTransientIconName">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Sets the
<doc:ref type="property" to="Hostname1:transient-icon-name">transient-icon-name</doc:ref>
property.
Typically only network configuration tools will need to
call this method.
</doc:para>
</doc:description>
<doc:permission>
Only the super user (<doc:tt>uid 0</doc:tt>) can invoke this method.
</doc:permission>
<doc:errors>
<doc:error name="&ERROR_INVALID_DATA;">if invalid data is passed</doc:error>
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
<arg name="cookie" direction="in" type="s">
<doc:doc>
<doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Hostname1.RegisterTransientDataProvider">RegisterTransientDataProvider()</doc:ref>
method.
</doc:summary>
</doc:doc>
</arg>
<arg name="icon_name" direction="in" type="s">
<doc:doc>
<doc:summary>
The name for the host icon. Must be an empty string to unset the icon, otherwise a themed
icon name conforming to
the freedesktop.org
<doc:ulink url="http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html">Icon Theme Specification</doc:ulink>
and
<doc:ulink url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon Naming Specification</doc:ulink>
specifications.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ******************************************************************************** -->
<signal name="Changed">
<doc:doc>
<doc:description>
<doc:para>
Emitted when one or more properties change.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ******************************************************************************** -->
<property name="display-hostname" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The display hostname of the system. If empty, it means no display hostname
has been chosen for the system.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="hostname" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The hostname of the system. Is never the empty string. Conforms to section 3.5 of
<doc:ulink url="http://www.ietf.org/rfc/rfc1034.txt">RFC 1034</doc:ulink>
with the hostname being a label: 7 bit ASCII without special characters,
whitespace or dots.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="icon-name" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The name icon to use for the system. Is either an empty string if no icon is set, otherwise
a themed icon name conforming to
the freedesktop.org
<doc:ulink url="http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html">Icon Theme Specification</doc:ulink>
and
<doc:ulink url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon Naming Specification</doc:ulink>
specifications.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="configured-display-hostname" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The configured display hostname of the system. This is a user preference and can be changed with the
<doc:ref type="method" to="Hostname1.SetDisplayHostname">SetDisplayHostname()</doc:ref>
method.
This property is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:display-hostname">display-hostname</doc:ref>
property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="configured-hostname" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The configured hostname of the system. This is a user preference and can be changed with the
<doc:ref type="method" to="Hostname1.SetHostname">SetHostname()</doc:ref>
method.
This property is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:hostname">hostname</doc:ref>
property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="configured-icon-name" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The configured icon name of the system. This is a user preference and can be changed with the
<doc:ref type="method" to="Hostname1.SetIconName">SetIconName()</doc:ref>
method.
This property is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:icon-name">icon-name</doc:ref>
property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="use-transient-data" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
If <doc:tt>FALSE</doc:tt>, then transient data will be ignored when
computing the value of the
<doc:ref type="property" to="Hostname1:hostname">hostname</doc:ref>,
<doc:ref type="property" to="Hostname1:display-hostname">display-hostname</doc:ref> and
<doc:ref type="property" to="Hostname1:icon-name">icon-name</doc:ref>
properties.
This is a user preference and can be changed with the
<doc:ref type="method" to="Hostname1.SetIconName">SetUseTransientData()</doc:ref>
method.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="transient-display-hostname" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
If not blank, the display hostname currently provided by a registered transient data provider.
This property is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:display-hostname">display-hostname</doc:ref>
property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="transient-hostname" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
If not blank, the hostname currently provided by a registered transient data provider.
This property is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:hostname">hostname</doc:ref>
property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="transient-icon-name" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
If not blank, the icon name currently provided by a registered transient data provider.
This property is subject to the same format and limitations as the
<doc:ref type="property" to="Hostname1:icon-name">icon-name</doc:ref>
property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
<property name="can-set-hostname" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
Whether the
<doc:ref type="property" to="Hostname1:configured-hostname">configured-hostname</doc:ref>
property can be set using
<doc:ref type="method" to="Hostname1.SetHostname">SetHostname()</doc:ref>.
Note that even if this property has the value <doc:tt>TRUE</doc:tt>, authorization checks may
prevent any random client from changing the given property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="can-set-display-hostname" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
Whether the
<doc:ref type="property" to="Hostname1:configured-display-hostname">configured-display-hostname</doc:ref>
property can be set using
<doc:ref type="method" to="Hostname1.SetDisplayHostname">SetDisplayHostname()</doc:ref>.
Note that even if this property has the value <doc:tt>TRUE</doc:tt>, authorization checks may
prevent any random client from changing the given property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="can-set-icon-name" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
Whether the
<doc:ref type="property" to="Hostname1:configured-icon-name">configured-icon-name</doc:ref>
property can be set using
<doc:ref type="method" to="Hostname1.SetIconName">SetIconName()</doc:ref>.
Note that even if this property has the value <doc:tt>TRUE</doc:tt>, authorization checks may
prevent any random client from changing the given property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="can-set-use-transient-data" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
Whether the
<doc:ref type="property" to="Hostname1:use-transient-data">use-transient-data</doc:ref>
property can be set using
<doc:ref type="method" to="Hostname1.SetUseTransientData">SetUseTransientData()</doc:ref>.
Note that even if this property has the value <doc:tt>TRUE</doc:tt>, authorization checks may
prevent any random client from changing the given property.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!-- ******************************************************************************** -->
</interface>
</node>
|
