Plugin

---

Object Hierarchy:

Description:

Content:

Properties:

• public abstract string[] mechanisms { owned get; }
  This property holds a list of authentication mechanisms that the plugin implements, all specified within the authentication method.
• public abstract string type { owned get; }
  This property holds a plugin type, or authentication method it implements (for example "oauth" or "sasl").

Methods:

• public abstract void cancel ()
  This method cancels an ongoing authentication session.
• public abstract void refresh (SignonuiData ui_data)
  This method asks the plugin to refresh the UI.
• public abstract void request (SessionData session_data)
  This method provides the plugin with additional parameters for the session after the plugin has asked for it via response signal.
• public abstract void request_initial (SessionData session_data, Dictionary identity_method_cache, string mechanism)
  This method starts a new authentication session.
• public abstract void user_action_finished (SignonuiData ui_data)
  This method provides the plugin with the results of UI interaction after the plugin has asked for it via user_action_required signal.

Signals:

• public signal void error (Error error)
  This signal is issued by the plugin when an error has occurred, or the plugin otherwise has a reason to cancel the authentication session.
• public signal void refreshed (SignonuiData ui_data)
  This signal is issued by the plugin when the UI interaction is ongoing and the UI needs to be refreshed.
• public signal void response (SessionData session_data)
  This signal is issued by the plugin when it wants to provide an intermediate response to the application or needs additional information from the application.
• public signal void response_final (SessionData session_data)
  This signal is issued by the plugin when it has completed the authentication sequence and is used to provide the final response to the application.
• public signal void status_changed (PluginState state, string message)
  This signal is issued by the plugin when plugin state has changed.
• public signal void store (Dictionary identity_method_cache)
  This signal is issued by the plugin when it has data to store in persistent storage.
• public signal void user_action_required (SignonuiData ui_data)
  This signal is issued by the plugin when it needs a UI interaction with the user to happen.

Inherited Members: