diff options
| author | Dan Williams <dcbw@redhat.com> | 2012-08-06 18:42:00 -0500 |
|---|---|---|
| committer | Dan Williams <dcbw@redhat.com> | 2012-08-06 19:51:23 -0500 |
| commit | 0b52687dfe7157cadb162cdd1620775ea2350fee (patch) | |
| tree | b0307a8ac37a5e03222625cfe939d64b65f2785e /libnm-glib/nm-secret-agent.h | |
| parent | 2ecf61a29a234306d8125bea637e5f8a3c443272 (diff) | |
| download | NetworkManager-0b52687dfe7157cadb162cdd1620775ea2350fee.tar.gz | |
docs: document secret agent errors
Diffstat (limited to 'libnm-glib/nm-secret-agent.h')
| -rw-r--r-- | libnm-glib/nm-secret-agent.h | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/libnm-glib/nm-secret-agent.h b/libnm-glib/nm-secret-agent.h index f2d9bcd7d7..50fc64ef7f 100644 --- a/libnm-glib/nm-secret-agent.h +++ b/libnm-glib/nm-secret-agent.h @@ -29,6 +29,23 @@ G_BEGIN_DECLS GQuark nm_secret_agent_error_quark (void); +/** + * NMSecretAgentError: + * @NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED: the caller (ie, NetworkManager) is not + * authorized to make this request + * @NM_SECRET_AGENT_ERROR_INVALID_CONNECTION: the connection for which secrets + * were requested could not be found + * @NM_SECRET_AGENT_ERROR_USER_CANCELED: the request was canceled by the user + * @NM_SECRET_AGENT_ERROR_AGENT_CANCELED: the agent canceled the request + * because it was requested to do so by NetworkManager + * @NM_SECRET_AGENT_ERROR_INTERNAL_ERROR: some internal error in the agent caused + * the request to fail + * @NM_SECRET_AGENT_ERROR_NO_SECRETS: the agent cannot find any secrets for this + * connection + * + * #NMSecretAgentError values are passed by secret agents back to NetworkManager + * when they encounter problems retrieving secrets on behalf of NM. + */ typedef enum { NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED = 0, /*< nick=NotAuthorized >*/ NM_SECRET_AGENT_ERROR_INVALID_CONNECTION, /*< nick=InvalidConnection >*/ @@ -57,7 +74,7 @@ typedef enum { * * #NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request. */ -typedef enum { +typedef enum /*< flags >*/ { NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0, NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1, NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2, |