*
* Get human readable name of the extension.
*
- * Returns: (transfer none) name of the extension.
+ * Returns: (transfer none): name of the extension.
*/
const gchar * (*get_extension_name) (GSignondExtension *self);
/**
* gsignond_db_secret_database_new:
*
* Creates new #GSignondDbSecretDatabase object
- * Returns : (transfer full) the #GSignondDbSecretDatabase object
+ * Returns : (transfer full): the #GSignondDbSecretDatabase object
*
*/
GSignondDbSecretDatabase *
*
* Prepares the statement from the query.
*
- * Returns: (transfer full) NULL if fails, valid sql statement otherwise.
+ * Returns: (transfer full): NULL if fails, valid sql statement otherwise.
*/
sqlite3_stmt *
gsignond_db_sql_database_prepare_statement (
*
* Executes an SQL statement, and returns the fetched integer from the result.
*
- * Returns: (transfer full) string if rows fetched are greater than 0,
+ * Returns: (transfer full): string if rows fetched are greater than 0,
* NULL otherwise.
*/
gchar *
* Executes an SQL statement, and returns the fetched strings from the results
* in the list.
*
- * Returns: (transfer full) list if rows fetched are greater than 0,
+ * Returns: (transfer full): list if rows fetched are greater than 0,
* NULL otherwise. When done with list, it must be freed using
* g_list_free_full (list, g_free)
*/
* Executes an SQL statement, and returns the fetched string tuples from
* the results into the hash table.
*
- * Returns: (transfer full) string tuples if rows fetched are greater than 0,
+ * Returns: (transfer full): string tuples if rows fetched are greater than 0,
* NULL otherwise. When done with tuples, it must be freed using
* g_hash_table_unref (tuples)
*/
* Executes an SQL statement, and returns the fetched int-string tuples from
* the results into the hash table.
*
- * Returns: (transfer full) string tuples if rows fetched are greater than 0,
+ * Returns: (transfer full): string tuples if rows fetched are greater than 0,
* NULL otherwise.
*/
GHashTable *
* Executes an SQL statement, and returns the fetched integers from the results
* in the array.
*
- * Returns: (transfer full) list if rows fetched are greater than 0, NULL otherwise.
+ * Returns: (transfer full): list if rows fetched are greater than 0, NULL otherwise.
*/
GArray *
gsignond_db_sql_database_query_exec_int_array (
/**
* gsignond_db_sql_database_query_exec_stmt:
* @self: instance of #GSignondDbSqlDatabase
- * @sql_stmt: (transfer full) sql statement executed on the database
+ * @sql_stmt: (transfer full): sql statement executed on the database
* @callback: callback to be invoked if not NULL for the result of each row
* @userdata: user_data to be relayed back through the callback
*
/**
* gsignond_db_sql_database_set_last_error:
* @self: instance of #GSignondDbDefaultStorage
- * @error: (transfer full) last occurred #GError
+ * @error: (transfer full): last occurred #GError
*
* sets the last occurred error
*
*
* Loads the credentials.
*
- * Returns: (transfer full) #GSignondCredentials if successful,
+ * Returns: (transfer full): #GSignondCredentials if successful,
* NULL otherwise.
*/
GSignondCredentials*
* gsignond_secret_storage_update_credentials:
*
* @self: instance of #GSignondSecretStorage
- * @creds: (transfer none) the credentials that are being updated.
+ * @creds: (transfer none): the credentials that are being updated.
*
* Stores/updates the credentials for the given identity.
*
* gsignond_secret_storage_check_credentials:
*
* @self: instance of #GSignondSecretStorage
- * @creds: (transfer none) the credentials that are being checked.
+ * @creds: (transfer none): the credentials that are being checked.
*
* Checks whether the given credentials are correct for the
* given identity.
*
* Loads secret data.
*
- * Returns: (transfer full) #GHashTable (gchar*, GBytes*) data. When done data
+ * Returns: (transfer full): #GHashTable (gchar*, GBytes*) data. When done data
* should be freed with g_hash_table_unref (data)
*/
GHashTable*
* @self: instance of #GSignondSecretStorage
* @id: the identity whose credentials are being fetched.
* @method: the authentication method the data is used for.
- * @data: (transfer none) the data as #GHashTable (gchar*, GBytes*)
+ * @data: (transfer none): the data as #GHashTable (gchar*, GBytes*)
*
* Stores/replaces secret data. Calling this method replaces any data
* which was previously stored for the given id/method.
/**
* gsignond_secret_storage_set_last_error:
* @self: instance of #GSignondDbDefaultStorage
- * @error : (transfer full) last occurred #GError
+ * @error : (transfer full): last occurred #GError
*
* sets the last occurred error
*
*
* retrieves the last occurred error
*
- * Returns: (transfer none) last occurred #GError
+ * Returns: (transfer none): last occurred #GError
*/
const GError *
gsignond_secret_storage_get_last_error (GSignondSecretStorage *self)
* gsignond_credentials_new:
*
* Creates new #GSignondCredentials object
- * Returns : (transfer full) the #GSignondCredentials object
+ * Returns : (transfer full): the #GSignondCredentials object
*
*/
GSignondCredentials *
* the dictionary needs to be deserialized, or if it's contained in another
* #GSignondDictionary and has been retrieved using gsignond_dictionary_get().
*
- * Returns: (transfer full) #GSignondDictionary if successful, NULL otherwise.
+ * Returns: (transfer full): #GSignondDictionary if successful, NULL otherwise.
*/
GSignondDictionary *
gsignond_dictionary_new_from_variant (GVariant *variant)
* Converts the #GSignondDictionary to a #GVariant. The result can be serialized
* or put into another #GSignondDictionary using gsignond_dictionary_set().
*
- * Returns: (transfer full) #GVariant object if successful, NULL otherwise.
+ * Returns: (transfer full): #GVariant object if successful, NULL otherwise.
*/
GVariant *
gsignond_dictionary_to_variant (GSignondDictionary *dict)
*
* Creates a new instance of #GSignondDictionary.
*
- * Returns: (transfer full) #GSignondDictionary object if successful,
+ * Returns: (transfer full): #GSignondDictionary object if successful,
* NULL otherwise.
*/
GSignondDictionary *
* return the specific type directly are provided (gsignond_dictionary_get_string()
* and similar).
*
- * Returns: (transfer none) the value; NULL is returned in case of failure (for
+ * Returns: (transfer none): the value; NULL is returned in case of failure (for
* example if the entry corresponding to the supplied key doesn't exist).
*/
GVariant *
/**
* gsignond_dictionary_set:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to be set
- * @value: (transfer full) value to be set
+ * @key: (transfer none): key to be set
+ * @value: (transfer full): value to be set
*
* Adds or replaces key-value pair in the dictionary. This allows to set a value
* of an arbitrary type: it first needs to be converted to a #GVariant. For most
/**
* gsignond_dictionary_get_boolean:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to look up
+ * @key: (transfer none): key to look up
* @value: points to the location where the value should be set
*
* Retrieves a gboolean value.
/**
* gsignond_dictionary_set_boolean:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to set
+ * @key: (transfer none): key to set
* @value: value to set
*
* Sets or replaces a gboolean value in the dictionary.
/**
* gsignond_dictionary_get_int32:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to look up
+ * @key: (transfer none): key to look up
* @value: points to the location where the value should be set
*
* Retrieves a int32 value.
/**
* gsignond_dictionary_set_int32:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to set
+ * @key: (transfer none): key to set
* @value: value to set
*
* Sets or replaces a int32 value in the dictionary.
/**
* gsignond_dictionary_get_uint32:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to look up
+ * @key: (transfer none): key to look up
* @value: points to the location where the value should be set
*
* Retrieves a uint32 value.
/**
* gsignond_dictionary_set_uint32:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to set
+ * @key: (transfer none): key to set
* @value: value to set
*
* Sets or replaces a uint32 value in the dictionary.
/**
* gsignond_dictionary_get_int64:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to look up
+ * @key: (transfer none): key to look up
* @value: points to the location where the value should be set
*
* Retrieves a int64 value.
/**
* gsignond_dictionary_set_int64:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to set
+ * @key: (transfer none): key to set
* @value: value to set
*
* Sets or replaces a int64 value in the dictionary.
/**
* gsignond_dictionary_get_uint64:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to look up
+ * @key: (transfer none): key to look up
* @value: points to the location where the value should be set
*
* Retrieves a uint64 value.
/**
* gsignond_dictionary_set_uint64:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to set
+ * @key: (transfer none): key to set
* @value: value to set
*
* Sets or replaces a uint64 value in the dictionary.
/**
* gsignond_dictionary_get_string:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to look up
+ * @key: (transfer none): key to look up
*
* Retrieves a string value.
*
- * Returns: (transfer none) the value if it was retrieved successfully, NULL otherwise.
+ * Returns: (transfer none): the value if it was retrieved successfully, NULL otherwise.
*/
const gchar *
gsignond_dictionary_get_string (GSignondDictionary *dict, const gchar *key)
/**
* gsignond_dictionary_set_string:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key to set
- * @value: (transfer none) value to set
+ * @key: (transfer none): key to set
+ * @value: (transfer none): value to set
*
* Sets or replaces a string value in the dictionary.
*
/**
* gsignond_dictionary_remove:
* @dict: instance of #GSignondDictionary
- * @key: (transfer none) key which needs to be removed from the dictionary
+ * @key: (transfer none): key which needs to be removed from the dictionary
*
* Removes key-value pair in the dictionary as per key.
*
*
* Creates a copy of the dictionary.
*
- * Returns: (transfer full) #GSignondDictionary object if the copy was successful,
+ * Returns: (transfer full): #GSignondDictionary object if the copy was successful,
* NULL otherwise.
*/
GSignondDictionary *
*
* Converts the GVariant to GError.
*
- * Returns: (transfer full) #GError object if successful, NULL otherwise.
+ * Returns: (transfer full): #GError object if successful, NULL otherwise.
*/
GError *
gsignond_error_new_from_variant (
*
* Converts the GError to GVariant.
*
- * Returns: (transfer full) #GVariant object if successful, NULL otherwise.
+ * Returns: (transfer full): #GVariant object if successful, NULL otherwise.
*/
GVariant *
gsignond_error_to_variant (
*
* Get human readable name of the extension.
*
- * Returns: (transfer none) name of the extension.
+ * Returns: (transfer none): name of the extension.
*/
const gchar *
gsignond_extension_get_name (GSignondExtension *self)
*
* Factory method to get a singleton storage manager object.
*
- * Returns: (transfer none) storage manager object instance.
+ * Returns: (transfer none): storage manager object instance.
*/
GSignondStorageManager *
gsignond_extension_get_storage_manager (GSignondExtension *self,
*
* Factory method to get a singleton secret storage object.
*
- * Returns: (transfer none) secret storage object instance.
+ * Returns: (transfer none): secret storage object instance.
*/
GSignondSecretStorage *
gsignond_extension_get_secret_storage (GSignondExtension *self,
*
* Factory method to get a singleton access control manager object.
*
- * Returns: (transfer none) access control manager object instance.
+ * Returns: (transfer none): access control manager object instance.
*/
GSignondAccessControlManager *
gsignond_extension_get_access_control_manager (GSignondExtension *self,
*
* Creates new instance of GSignondIdentityInfo.
*
- * Returns: (transfer full) #GSignondIdentityInfo object if successful,
+ * Returns: (transfer full): #GSignondIdentityInfo object if successful,
* NULL otherwise.
*/
GSignondIdentityInfo *
*
* Retrieves the realms from the info.
*
- * Returns: (transfer full) the realms if successful, NULL Otherwise.
+ * Returns: (transfer full): the realms if successful, NULL Otherwise.
* when done realms should be freed using g_sequence_free.
*/
GSequence *
* gsignond_identity_info_set_realms:
* @info: instance of #GSignondIdentityInfo
*
- * @realms: (transfer none) realms to be set
+ * @realms: (transfer none): realms to be set
*
* Sets the realms of the info.
*
* Retrieves the methods from the info whereas #GHashTable consists of
* (gchar*,GSequence*) and #GSequence is a sequence of gchar *.
*
- * Returns: (transfer full) the methods if successful, NULL otherwise.
+ * Returns: (transfer full): the methods if successful, NULL otherwise.
* when done, methods should be freed using g_hash_table_unref.
*/
GHashTable *
* gsignond_identity_info_set_methods:
* @info: instance of #GSignondIdentityInfo
*
- * @methods: (transfer none) methods to be set whereas #GHashTable consists of
+ * @methods: (transfer none): methods to be set whereas #GHashTable consists of
* (gchar*,#GSequence*) and #GSequence is a sequence of gchar *.
*
* Sets the methods of the info.
*
* Retrieves the mechanisms from the info.
*
- * Returns: (transfer full) the mechanisms if successful, NULL otherwise.
+ * Returns: (transfer full): the mechanisms if successful, NULL otherwise.
* when done, mechanisms should be freed using g_sequence_free; #GSequence is a
* sequence of gchar *.
*/
*
* Retrieves the access control list from the info.
*
- * Returns: (transfer full) the list if successful, NULL otherwise.
+ * Returns: (transfer full): the list if successful, NULL otherwise.
* when done, list should be freed using gsignond_security_context_list_free.
*/
GSignondSecurityContextList *
* gsignond_identity_info_set_access_control_list:
* @info: instance of #GSignondIdentityInfo
*
- * @acl: (transfer none) access control list to be set
+ * @acl: (transfer none): access control list to be set
*
* Sets the access control list of the info.
*
*
* Retrieves the id from the info.
*
- * Returns: (transfer full) the owner if successful, NULL otherwise.
+ * Returns: (transfer full): the owner if successful, NULL otherwise.
* when done, owner list should be freed using
* gsignond_security_context_free.
*/
* gsignond_identity_info_set_owner:
* @info: instance of #GSignondIdentityInfo
*
- * @owners: (transfer none) owner to be set
+ * @owners: (transfer none): owner to be set
*
* Sets the owner of the info.
*
/**
* GSignondPluginState:
* @GSIGNOND_PLUGIN_STATE_NONE: State unknown
- * @SIGNOND_PLUGIN_STATE_RESOLVING: Resolving remote server host name
+ * @GSIGNOND_PLUGIN_STATE_RESOLVING: Resolving remote server host name
* @GSIGNOND_PLUGIN_STATE_CONNECTING: Connecting to remote server
* @GSIGNOND_PLUGIN_STATE_SENDING_DATA: Sending data to remote server
* @GSIGNOND_PLUGIN_STATE_WAITING: Waiting for reply from remote server
* @GSIGNOND_PLUGIN_STATE_CANCELING: Canceling current process
* @GSIGNOND_PLUGIN_STATE_DONE: Process is finished
* @GSIGNOND_PLUGIN_STATE_HOLDING: Holding long non-expired token
- * @GSIGNOND_PLUGIN_STATE_CUSTOM: Custom message
*/
*
* Allocates a new security context item.
*
- * Returns: (transfer full) allocated #GSignondSecurityContext.
+ * Returns: (transfer full): allocated #GSignondSecurityContext.
*/
GSignondSecurityContext *
gsignond_security_context_new ()
*
* Allocates and initializes a new security context item.
*
- * Returns: (transfer full) allocated #GSignondSecurityContext.
+ * Returns: (transfer full): allocated #GSignondSecurityContext.
*/
GSignondSecurityContext *
gsignond_security_context_new_from_values (const gchar *system_context,
*
* Copy a security context item.
*
- * Returns: (transfer full) a copy of the #GSignondSecurityContext item.
+ * Returns: (transfer full): a copy of the #GSignondSecurityContext item.
*/
GSignondSecurityContext *
gsignond_security_context_copy (const GSignondSecurityContext *src_ctx)
* Get the system context part (such as SMACK label or MSSF token) of the
* #GSignondSecurityContext.
*
- * Returns: (transfer none) system context.
+ * Returns: (transfer none): system context.
*/
const gchar *
gsignond_security_context_get_system_context (
* Get the application context part (such as script name or a web page) of
* the #GSignondSecurityContext.
*
- * Returns: (transfer none) application context.
+ * Returns: (transfer none): application context.
*/
const gchar *
gsignond_security_context_get_application_context (
*
* Build a GVariant of type "(ss)" from a #GSignondSecurityContext item.
*
- * Returns: (transfer full) GVariant construct of a #GSignondSecurityContext.
+ * Returns: (transfer full): GVariant construct of a #GSignondSecurityContext.
*/
GVariant *
gsignond_security_context_to_variant (const GSignondSecurityContext *ctx)
*
* Builds a #GSignondSecurityContext item from a GVariant of type "(ss)".
*
- * Returns: (transfer full) #GSignondSecurityContext item.
+ * Returns: (transfer full): #GSignondSecurityContext item.
*/
GSignondSecurityContext *
gsignond_security_context_from_variant (GVariant *variant)
* Builds a GVariant of type "a(ss)" from a GList of #GSignondSecurityContext
* items.
*
- * Returns: (transfer full) GVariant construct of a #GSignondSecurityContextList.
+ * Returns: (transfer full): GVariant construct of a #GSignondSecurityContextList.
*/
GVariant *
gsignond_security_context_list_to_variant (
* Builds a GList of #GSignondSecurityContext items from a GVariant of type
* "a(ss)".
*
- * Returns: (transfer full) #GSignondSecurityContextList item.
+ * Returns: (transfer full): #GSignondSecurityContextList item.
*/
GSignondSecurityContextList *
gsignond_security_context_list_from_variant (GVariant *variant)
*
* Copies a GList of #GSignondSecurityContext items.
*
- * Returns: (transfer full) #GSignondSecurityContextList item.
+ * Returns: (transfer full): #GSignondSecurityContextList item.
*/
GSignondSecurityContextList *
gsignond_security_context_list_copy (
/**
* gsignond_security_context_list_free:
- * @seclist: (transfer full) #GSignondSecurityContextList item.
+ * @seclist: (transfer full): #GSignondSecurityContextList item.
*
* Frees all items and the GList of #GSignondSecurityContext.
*/
*
* A getter for the user's response to a captcha query.
*
- * Returns: (transfer none) the string entered by the user in response to a captcha query.
+ * Returns: (transfer none): the string entered by the user in response to a captcha query.
*/
const gchar*
gsignond_signonui_data_get_captcha_response (GSignondSignonuiData *data)
*
* A getter for the captcha URL.
*
- * Returns: (transfer none) the URL to the captcha image to be verified by user.
+ * Returns: (transfer none): the URL to the captcha image to be verified by user.
*/
const gchar*
gsignond_signonui_data_get_captcha_url (GSignondSignonuiData *data)
* A setter for the forgot password string, which is shown to the user as a link to
* reset the password or remind him of the password.
*
- * Returns: (transfer none)
+ * Returns: (transfer none):
*/
void
gsignond_signonui_data_set_forgot_password (GSignondSignonuiData *data,
* Mounts an encrypted storage and returns filesystem path of the storage
* mount point.
*
- * Returns: (transfer none) path of the storage mount point.
+ * Returns: (transfer none): path of the storage mount point.
*/
const gchar *
gsignond_storage_manager_mount_filesystem (GSignondStorageManager *self)
projects / platform / upstream / gsignond.git / commitdiff