|  |  |  | Liboobs (System configuration management) Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
enum OobsResult; OobsPlatform; OobsSession; OobsSession * oobs_session_get (void); OobsResult oobs_session_commit (OobsSession *session); OobsResult oobs_session_get_supported_platforms (OobsSession *session, GList **platforms); OobsResult oobs_session_get_platform (OobsSession *session, gchar **platform); OobsResult oobs_session_set_platform (OobsSession *session, const gchar *platform); gboolean oobs_session_get_connected (OobsSession *session); void oobs_session_process_requests (OobsSession *session);
OobsSession is a singleton object, defines and abstracts the connection to system-tools-backends.
typedef enum {
  OOBS_RESULT_OK,
  OOBS_RESULT_ACCESS_DENIED,
  OOBS_RESULT_NO_PLATFORM,
  OOBS_RESULT_MALFORMED_DATA,
  OOBS_RESULT_ERROR
} OobsResult;
Defines the result of an operation.
| Success. | |
| Access to the backends denied, either by policies of for being unable to get enough privileges | |
| No detected platform, see oobs_session_set_platform(). | |
| Tried to send some kind of malformed data to the backends | |
| Unmanaged error. | 
typedef struct {
  const gchar *id;
  const gchar *name;
  const gchar *version;
  const gchar *codename;
} OobsPlatform;
Represents a platform where system-tools-backends may run.
OobsSession * oobs_session_get (void);
Returns the OobsSession singleton, which represents the session with the system tools backends.
| Returns : | the singleton OobSession object. | 
OobsResult oobs_session_commit (OobsSession *session);
Commits inmediately all the changes to the configuration objects that have been requested through this OobsSession. Note that it will stop if it finds any error.
| 
 | an OobsSession | 
| Returns : | An OobsResult representing the error. | 
OobsResult oobs_session_get_supported_platforms (OobsSession *session, GList **platforms);
Retrieves the list of supported platforms, this is only necessary when
 + oobs_session_get_platform() has returned OOBS_RESULT_NO_PLATFORM. To
specify a platform, you must use oobs_session_set_platform(), being
the platform string in that function the platform->id value inside
the OobsPlatform struct.
| 
 | An OobsSession. | 
| 
 | return location for the list of platforms. It's a
            GList of OobsPlatform structs. You must free
            this list with g_list_free(). | 
| Returns : | An OobsResult representing the error. | 
OobsResult oobs_session_get_platform (OobsSession *session, gchar **platform);
Retrieves the platform your system has been identified with, or NULL in case your platform is not recognized or other error happens.
| 
 | An OobsSession. | 
| 
 | location to store the current platform, or NULL. This string is of internal use, and must not be freed or modified. | 
| Returns : | An OobsResult representing the error. | 
OobsResult oobs_session_set_platform (OobsSession *session, const gchar *platform);
Identifies your platform as the one set in platform. This is only necessary if
your platform could not be guessed (and thus oobs_session_get_platform() would
return OOBS_RESULT_NO_PLATFORM in this case).
| 
 | An OobsSession. | 
| 
 | A string defining the platform. see oobs_session_get_platforms_list()to know where to get this string. | 
| Returns : | An OobsResult representing the error. | 
gboolean oobs_session_get_connected (OobsSession *session);
Returns whether the connection with the backends is established.
| 
 | An OobsSession | 
| Returns : | TRUE if there's connection with the backends. | 
void oobs_session_process_requests (OobsSession *session);
Blocks until all pending asynchronous requests have been processed.
| 
 | An OobsSession | 
"platform" property"platform" gchar* : Read / Write
Name of the platform the session is running on.
Default value: NULL