Core API Reference - Seat
Desktop Apps Training - Policy Kit

Seat

Seat — Represents a ConsoleKit Seat.

  

Synopsis



                    PolKitSeat;
PolKitSeat*         polkit_seat_new                     (void);
PolKitSeat*         polkit_seat_ref                     (PolKitSeat *seat);
void                polkit_seat_unref                   (PolKitSeat *seat);
polkit_bool_t       polkit_seat_set_ck_objref           (PolKitSeat *seat,
                                                         const char *ck_objref);
polkit_bool_t       polkit_seat_get_ck_objref           (PolKitSeat *seat,
                                                         char **out_ck_objref);
void                polkit_seat_debug                   (PolKitSeat *seat);
polkit_bool_t       polkit_seat_validate                (PolKitSeat *seat);

Description

This class is used to represent a seat.

 

Details

PolKitSeat

typedef struct _PolKitSeat PolKitSeat;

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

 

polkit_seat_new ()

PolKitSeat*         polkit_seat_new                     (void);

Creates a new PolKitSeat object.

 

Returns :

 the new object

polkit_seat_ref ()

PolKitSeat*         polkit_seat_ref                     (PolKitSeat *seat);

Increase reference count.

 

seat :

 the seat object

Returns :

 the object

polkit_seat_unref ()

void                polkit_seat_unref                   (PolKitSeat *seat);

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.

 

seat :

 the seat object

polkit_seat_set_ck_objref ()

polkit_bool_t       polkit_seat_set_ck_objref           (PolKitSeat *seat,
                                                         const char *ck_objref);

Set the D-Bus object path to the ConsoleKit seat object.

 

seat :

 the seat object

ck_objref :

 the D-Bus object path to the ConsoleKit seat object

Returns :

 TRUE only if the value validated and was set

polkit_seat_get_ck_objref ()

polkit_bool_t       polkit_seat_get_ck_objref           (PolKitSeat *seat,
                                                         char **out_ck_objref);

Get the D-Bus object path to the ConsoleKit seat object.

 

seat :

 the seat object

out_ck_objref :

 Returns the D-Bus object path to the ConsoleKit seat object. The caller shall not free this string.

Returns :

 TRUE iff the value is returned

polkit_seat_debug ()

void                polkit_seat_debug                   (PolKitSeat *seat);

Print debug details

 

seat :

 the object

polkit_seat_validate ()

polkit_bool_t       polkit_seat_validate                (PolKitSeat *seat);

Validate the object

 

seat :

 the object

Returns :

 TRUE iff the object is valid.