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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="AsValidatorIssue">
<refmeta>
<refentrytitle role="top_of_page" id="AsValidatorIssue.top_of_page">AsValidatorIssue</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AsValidatorIssue</refname>
<refpurpose>Object representing an issue found in AppStream metadata</refpurpose>
</refnamediv>
<refsect1 id="AsValidatorIssue.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsValidatorIssue"><returnvalue>AsValidatorIssue</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-validator-issue-new">as_validator_issue_new</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsIssueKind"><returnvalue>AsIssueKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-issue-get-kind">as_validator_issue_get_kind</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-issue-set-kind">as_validator_issue_set_kind</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsIssueImportance"><returnvalue>AsIssueImportance</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-issue-get-importance">as_validator_issue_get_importance</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-issue-set-importance">as_validator_issue_set_importance</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-validator-issue-get-message">as_validator_issue_get_message</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-issue-set-message">as_validator_issue_set_message</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsValidatorIssue.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsIssueImportance">AsIssueImportance</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsIssueKind">AsIssueKind</link></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsValidatorIssue.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen> <link linkend="GObject">GObject</link>
<phrase role="lineart">╰──</phrase> AsValidatorIssue
</screen>
</refsect1>
<refsect1 id="AsValidatorIssue.includes"><title>Includes</title><synopsis>#include <appstream.h>
</synopsis></refsect1>
<refsect1 id="AsValidatorIssue.description" role="desc">
<title role="desc.title">Description</title>
<para>See also: <link linkend="AsValidator"><type>AsValidator</type></link></para>
</refsect1>
<refsect1 id="AsValidatorIssue.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-validator-issue-new" role="function">
<title>as_validator_issue_new ()</title>
<indexterm zone="as-validator-issue-new"><primary>as_validator_issue_new</primary></indexterm>
<programlisting language="C"><link linkend="AsValidatorIssue"><returnvalue>AsValidatorIssue</returnvalue></link> *
as_validator_issue_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link>.</para>
<refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-validator-issue-get-kind" role="function">
<title>as_validator_issue_get_kind ()</title>
<indexterm zone="as-validator-issue-get-kind"><primary>as_validator_issue_get_kind</primary></indexterm>
<programlisting language="C"><link linkend="AsIssueKind"><returnvalue>AsIssueKind</returnvalue></link>
as_validator_issue_get_kind (<parameter><link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> *issue</parameter>);</programlisting>
<para>Gets the issue kind enum, if available.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>issue</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsIssueKind"><type>AsIssueKind</type></link></para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-validator-issue-set-kind" role="function">
<title>as_validator_issue_set_kind ()</title>
<indexterm zone="as-validator-issue-set-kind"><primary>as_validator_issue_set_kind</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_validator_issue_set_kind (<parameter><link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> *issue</parameter>,
<parameter><link linkend="AsIssueKind"><type>AsIssueKind</type></link> kind</parameter>);</programlisting>
<para>Sets the kind enum for this issue, if known.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>issue</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsIssueKind"><type>AsIssueKind</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-validator-issue-get-importance" role="function">
<title>as_validator_issue_get_importance ()</title>
<indexterm zone="as-validator-issue-get-importance"><primary>as_validator_issue_get_importance</primary></indexterm>
<programlisting language="C"><link linkend="AsIssueImportance"><returnvalue>AsIssueImportance</returnvalue></link>
as_validator_issue_get_importance (<parameter><link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> *issue</parameter>);</programlisting>
<para>Gets the importance of this issue.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>issue</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> a <link linkend="AsIssueImportance"><type>AsIssueImportance</type></link></para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-validator-issue-set-importance" role="function">
<title>as_validator_issue_set_importance ()</title>
<indexterm zone="as-validator-issue-set-importance"><primary>as_validator_issue_set_importance</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_validator_issue_set_importance (<parameter><link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> *issue</parameter>,
<parameter><link linkend="AsIssueImportance"><type>AsIssueImportance</type></link> importance</parameter>);</programlisting>
<para>Sets the importance for this issue.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>issue</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>importance</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsIssueImportance"><type>AsIssueImportance</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-validator-issue-get-message" role="function">
<title>as_validator_issue_get_message ()</title>
<indexterm zone="as-validator-issue-get-message"><primary>as_validator_issue_get_message</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
as_validator_issue_get_message (<parameter><link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> *issue</parameter>);</programlisting>
<para>Gets the message for the issue.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>issue</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the message</para>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-validator-issue-set-message" role="function">
<title>as_validator_issue_set_message ()</title>
<indexterm zone="as-validator-issue-set-message"><primary>as_validator_issue_set_message</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_validator_issue_set_message (<parameter><link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> *issue</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *message</parameter>);</programlisting>
<para>Sets a message on the issue.</para>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>issue</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>message</para></entry>
<entry role="parameter_description"><para>the message text.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
<refsect1 id="AsValidatorIssue.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AsIssueImportance" role="enum">
<title>enum AsIssueImportance</title>
<indexterm zone="AsIssueImportance"><primary>AsIssueImportance</primary></indexterm>
<para>The importance of an issue found by <link linkend="AsValidator"><type>AsValidator</type></link></para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-IMPORTANCE-UNKNOWN:CAPS">AS_ISSUE_IMPORTANCE_UNKNOWN</para></entry>
<entry role="enum_member_description"></entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-IMPORTANCE-ERROR:CAPS">AS_ISSUE_IMPORTANCE_ERROR</para></entry>
<entry role="enum_member_description"><para>There is a serious error in your metadata</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-IMPORTANCE-WARNING:CAPS">AS_ISSUE_IMPORTANCE_WARNING</para></entry>
<entry role="enum_member_description"><para>Something which should be fixed, but is not fatal</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-IMPORTANCE-INFO:CAPS">AS_ISSUE_IMPORTANCE_INFO</para></entry>
<entry role="enum_member_description"><para>Non-essential information on how to improve your metadata</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-IMPORTANCE-PEDANTIC:CAPS">AS_ISSUE_IMPORTANCE_PEDANTIC</para></entry>
<entry role="enum_member_description"><para>Pedantic information</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="AsIssueKind" role="enum">
<title>enum AsIssueKind</title>
<indexterm zone="AsIssueKind"><primary>AsIssueKind</primary></indexterm>
<para>The issue type.</para>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-UNKNOWN:CAPS">AS_ISSUE_KIND_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>Type invalid or not known</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-MARKUP-INVALID:CAPS">AS_ISSUE_KIND_MARKUP_INVALID</para></entry>
<entry role="enum_member_description"><para>The XML markup is invalid</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-LEGACY:CAPS">AS_ISSUE_KIND_LEGACY</para></entry>
<entry role="enum_member_description"><para>An element from a legacy AppStream specification has been found</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-TAG-DUPLICATED:CAPS">AS_ISSUE_KIND_TAG_DUPLICATED</para></entry>
<entry role="enum_member_description"><para>A tag is duplicated</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-TAG-MISSING:CAPS">AS_ISSUE_KIND_TAG_MISSING</para></entry>
<entry role="enum_member_description"><para>A required tag is missing</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-TAG-UNKNOWN:CAPS">AS_ISSUE_KIND_TAG_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>An unknown tag was found</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-TAG-NOT-ALLOWED:CAPS">AS_ISSUE_KIND_TAG_NOT_ALLOWED</para></entry>
<entry role="enum_member_description"><para>A tag is not allowed in the current context</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-PROPERTY-MISSING:CAPS">AS_ISSUE_KIND_PROPERTY_MISSING</para></entry>
<entry role="enum_member_description"><para>A required property is missing</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-PROPERTY-INVALID:CAPS">AS_ISSUE_KIND_PROPERTY_INVALID</para></entry>
<entry role="enum_member_description"><para>A property is invalid</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-VALUE-WRONG:CAPS">AS_ISSUE_KIND_VALUE_WRONG</para></entry>
<entry role="enum_member_description"><para>The value of a tag or property is wrong</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ISSUE-KIND-VALUE-ISSUE:CAPS">AS_ISSUE_KIND_VALUE_ISSUE</para></entry>
<entry role="enum_member_description"><para>There is an issue with a tag or property value (often non-fatal)</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
</refentry>
|
