AsValidatorIssue: AppStream Library Reference Manual

## AsValidatorIssue AsValidatorIssue — Object representing an issue found in AppStream metadata |

## Functions

#define | AS_TYPE_VALIDATOR_ISSUE
AsValidatorIssue * | as_validator_issue_new ()
AsIssueKind | as_validator_issue_get_kind ()
void | as_validator_issue_set_kind ()
AsIssueImportance | as_validator_issue_get_importance ()
void | as_validator_issue_set_importance ()
const gchar * | as_validator_issue_get_message ()
void | as_validator_issue_set_message ()
const gchar * | as_validator_issue_get_location ()
void | as_validator_issue_set_location ()

## Types and Values

struct | AsValidatorIssueClass
enum | AsIssueImportance
enum | AsIssueKind
| AsValidatorIssue

## Object Hierarchy

        GObject
        ╰── AsValidatorIssue

## Includes

    #include <appstream.h>

## Description

See also: AsValidator

## Functions

### AS_TYPE_VALIDATOR_ISSUE

    #define AS_TYPE_VALIDATOR_ISSUE (as_validator_issue_get_type ())

### as_validator_issue_new ()

    AsValidatorIssue *
    as_validator_issue_new (void);

Creates a new AsValidatorIssue.

#### Returns

a AsValidatorIssue.

[transfer full]

### as_validator_issue_get_kind ()

    AsIssueKind
    as_validator_issue_get_kind (AsValidatorIssue *issue);

Gets the issue kind enum, if available.

#### Parameters

issue | a AsValidatorIssue instance. |

#### Returns

a AsIssueKind

### as_validator_issue_set_kind ()

    void
    as_validator_issue_set_kind (AsValidatorIssue *issue,
                                 AsIssueKind kind);

Sets the kind enum for this issue, if known.

#### Parameters

issue | a AsValidatorIssue instance. |
kind | the AsIssueKind. |

### as_validator_issue_get_importance ()

    AsIssueImportance
    as_validator_issue_get_importance (AsValidatorIssue *issue);

Gets the importance of this issue.

#### Parameters

issue | a AsValidatorIssue instance. |

#### Returns

a AsIssueImportance

### as_validator_issue_set_importance ()

    void
    as_validator_issue_set_importance (AsValidatorIssue *issue,
                                       AsIssueImportance importance);

Sets the importance for this issue.

#### Parameters

issue | a AsValidatorIssue instance. |
importance | the AsIssueImportance. |

### as_validator_issue_get_message ()

    const gchar *
    as_validator_issue_get_message (AsValidatorIssue *issue);

Gets the message for the issue.

#### Parameters

issue | a AsValidatorIssue instance. |

#### Returns

the message

### as_validator_issue_set_message ()

    void
    as_validator_issue_set_message (AsValidatorIssue *issue,
                                    const gchar *message);

Sets a message on the issue.

#### Parameters

issue | a AsValidatorIssue instance. |
message | the message text. |

### as_validator_issue_get_location ()

    const gchar *
    as_validator_issue_get_location (AsValidatorIssue *issue);

Gets a location hint for the issue.

#### Parameters

issue | a AsValidatorIssue instance. |

#### Returns

the location hint

### as_validator_issue_set_location ()

    void
    as_validator_issue_set_location (AsValidatorIssue *issue,
                                     const gchar *location);

Sets a location hint for this issue.

#### Parameters

issue | a AsValidatorIssue instance. |
location | a location hint. |

## Types and Values

### struct AsValidatorIssueClass

    struct AsValidatorIssueClass {
    	GObjectClass		parent_class;
    };

### enum AsIssueImportance

The importance of an issue found by AsValidator

#### Members

AS_ISSUE_IMPORTANCE_UNKNOWN |  |
AS_ISSUE_IMPORTANCE_ERROR | There is a serious error in your metadata |
AS_ISSUE_IMPORTANCE_WARNING | Something which should be fixed, but is not fatal |
AS_ISSUE_IMPORTANCE_INFO | Non-essential information on how to improve your metadata |
AS_ISSUE_IMPORTANCE_PEDANTIC | Pedantic information |

### enum AsIssueKind

The issue type.

#### Members

AS_ISSUE_KIND_UNKNOWN | Type invalid or not known |
AS_ISSUE_KIND_MARKUP_INVALID | The XML markup is invalid |
AS_ISSUE_KIND_LEGACY | An element from a legacy AppStream specification has been found |
AS_ISSUE_KIND_TAG_DUPLICATED | A tag is duplicated |
AS_ISSUE_KIND_TAG_MISSING | A required tag is missing |
AS_ISSUE_KIND_TAG_UNKNOWN | An unknown tag was found |
AS_ISSUE_KIND_TAG_NOT_ALLOWED | A tag is not allowed in the current context |
AS_ISSUE_KIND_PROPERTY_MISSING | A required property is missing |
AS_ISSUE_KIND_PROPERTY_INVALID | A property is invalid |
AS_ISSUE_KIND_VALUE_MISSING | A value is missing |
AS_ISSUE_KIND_VALUE_WRONG | The value of a tag or property is wrong |
AS_ISSUE_KIND_VALUE_ISSUE | There is an issue with a tag or property value (often non-fatal) |
AS_ISSUE_KIND_FILE_MISSING | A required file or other metadata was missing |
AS_ISSUE_KIND_WRONG_NAME | The naming of an entity is wrong |
AS_ISSUE_KIND_READ_ERROR | Reading of data failed |

### AsValidatorIssue

    typedef struct _AsValidatorIssue AsValidatorIssue;