Policy File Entry

Policy File Entry — Represents a declared action in a policy file.

Synopsis




                    PolKitPolicyFileEntry;
void                (*PolKitPolicyFileEntryAnnotationsForeachFunc)
                                                        (PolKitPolicyFileEntry *policy_file_entry,
                                                         const char *key,
                                                         const char *value,
                                                         void *user_data);
PolKitPolicyFileEntry* polkit_policy_file_entry_ref     (PolKitPolicyFileEntry *policy_file_entry);
void                polkit_policy_file_entry_unref      (PolKitPolicyFileEntry *policy_file_entry);
void                polkit_policy_file_entry_debug      (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_entry_get_id     (PolKitPolicyFileEntry *policy_file_entry);
PolKitPolicyDefault* polkit_policy_file_entry_get_default
                                                        (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_entry_get_action_description
                                                        (PolKitPolicyFileEntry *policy_file_entry);
const char*         polkit_policy_file_entry_get_action_message
                                                        (PolKitPolicyFileEntry *policy_file_entry);
void                polkit_policy_file_entry_annotations_foreach
                                                        (PolKitPolicyFileEntry *policy_file_entry,
                                                         PolKitPolicyFileEntryAnnotationsForeachFunc cb,
                                                         void *user_data);
const char*         polkit_policy_file_entry_get_annotation
                                                        (PolKitPolicyFileEntry *policy_file_entry,
                                                         const char *key);

Description

This class is used to represent a entries in policy files.

Details

PolKitPolicyFileEntry

typedef struct _PolKitPolicyFileEntry PolKitPolicyFileEntry;

Objects of this class are used to record information about a policy.


PolKitPolicyFileEntryAnnotationsForeachFunc ()

void                (*PolKitPolicyFileEntryAnnotationsForeachFunc)
                                                        (PolKitPolicyFileEntry *policy_file_entry,
                                                         const char *key,
                                                         const char *value,
                                                         void *user_data);

Callback function for polkit_policy_file_entry_annotations_foreach().

policy_file_entry :

the policy file entry

key :

key of the annotation

value :

corrosponding value of the annotation

user_data :

user data passed to polkit_policy_file_entry_annotations_foreach()

polkit_policy_file_entry_ref ()

PolKitPolicyFileEntry* polkit_policy_file_entry_ref     (PolKitPolicyFileEntry *policy_file_entry);

Increase reference count.

policy_file_entry :

the policy file object

Returns :

the object

polkit_policy_file_entry_unref ()

void                polkit_policy_file_entry_unref      (PolKitPolicyFileEntry *policy_file_entry);

Decreases the reference count of the object. If it becomes zero, the object is freed. Before freeing, reference counts on embedded objects are decresed by one.

policy_file_entry :

the policy file object

polkit_policy_file_entry_debug ()

void                polkit_policy_file_entry_debug      (PolKitPolicyFileEntry *policy_file_entry);

Print debug information about object

policy_file_entry :

the entry

polkit_policy_file_entry_get_id ()

const char*         polkit_policy_file_entry_get_id     (PolKitPolicyFileEntry *policy_file_entry);

Get the action identifier.

policy_file_entry :

the file entry

Returns :

A string - caller shall not free this string.

polkit_policy_file_entry_get_default ()

PolKitPolicyDefault* polkit_policy_file_entry_get_default
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the the default policy for this policy.

policy_file_entry :

the file entry

Returns :

A PolKitPolicyDefault object - caller shall not unref this object.

polkit_policy_file_entry_get_action_description ()

const char*         polkit_policy_file_entry_get_action_description
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the description of the action that this policy entry describes. This is intended to be used in policy editors, for example "Mount internal volumes". Contrast with polkit_policy_file_entry_get_action_message(). The textual string will be returned in the current locale.

Note, if polkit_context_set_load_descriptions() on the PolKitContext object used to get this object wasn't called, this method will return NULL.

policy_file_entry :

the object

Returns :

string or NULL if descriptions are not loaded - caller shall not free this string

polkit_policy_file_entry_get_action_message ()

const char*         polkit_policy_file_entry_get_action_message
                                                        (PolKitPolicyFileEntry *policy_file_entry);

Get the message describing the action that this policy entry describes. This is to be used in dialogs, for example "System Policy prevents mounting this volume". Contrast with polkit_policy_file_entry_get_action_description(). The textual string will be returned in the current locale.

Note, if polkit_context_set_load_descriptions() on the PolKitContext object used to get this object wasn't called, this method will return NULL.

policy_file_entry :

the object

Returns :

string or NULL if descriptions are not loaded - caller shall not free this string

polkit_policy_file_entry_annotations_foreach ()

void                polkit_policy_file_entry_annotations_foreach
                                                        (PolKitPolicyFileEntry *policy_file_entry,
                                                         PolKitPolicyFileEntryAnnotationsForeachFunc cb,
                                                         void *user_data);

Iterate over all annotations on the policy file entry.

policy_file_entry :

the policy file entry

cb :

callback function

user_data :

user data to pass to the callback function

polkit_policy_file_entry_get_annotation ()

const char*         polkit_policy_file_entry_get_annotation
                                                        (PolKitPolicyFileEntry *policy_file_entry,
                                                         const char *key);

Look of the value of a given annotation.

policy_file_entry :

the policy file entry

key :

the key of the annotation

Returns :

The value of the annotation or NULL if not found.