Class
PurpleAccount
since: 2.0
Description [src]
final class Purple.Account : Purple.ContactInfo {
/* No available fields */
}A PurpleAccount is the core configuration for connecting to a specific
account. User interfaces typically allow users to create these in a dialog
or wizard.
Available since: 2.0
Instance methods
purple_account_freeze_notify_settings
Increment the freeze count for settings on account. When the freeze count
is greater than 0, the PurpleAccount::setting-changed signal will
not be emitted until the freeze count returns to 0.
since: 3.0
purple_account_get_error
Get the error that caused the account to be disconnected, or NULL if the
account is happily connected or disconnected without an error.
since: 3.0
purple_account_get_remember_password
Returns whether or not this account should save its password.
since: 2.0
purple_account_is_disconnecting
Indicates if the account is currently being disconnected.
since: 3.0
purple_account_request_change_password
Requests information from the user to change the account’s password.
since: 2.0
purple_account_request_change_user_info
Requests information from the user to change the account’s user information.
since: 2.0
purple_account_request_close_with_account
Close account requests registered for the given PurpleAccount.
since: 2.0
purple_account_request_password
Requests a password from the user for the account. Does not set the account password on success; do that in ok_cb if desired.
since: 2.0
purple_account_set_error
Sets the error of account to info. Note that setting this won’t disconnect
the account. This is intended to be called by libpurple when there is a
connection failure, when invalid settings are entered in an account editor,
or similar situations.
since: 3.0
purple_account_set_remember_password
Sets whether or not this account should save its password.
since: 2.0
purple_account_set_require_password
For protocols that have an optional password, this settings tells libpurple
that it should look for a password in the PurpleCredentialManager
or prompt the user if a password can not be found.
since: 3.0
Methods inherited from PurpleContactInfo (34)
Please see PurpleContactInfo for a full list of methods.
Properties
Purple.Account:buddy-icon-path
The path to the file to use as the avatar for this account.
since: 3.0
Purple.Account:connection
The PurpleConnection object for this account. This will be NULL when
the account is offline.
since: 3.0
Purple.Account:enabled
Whether or not this account should track the user’s global status.
since: 3.0
Purple.Account:error
The GError of the account. This is set when an account enters
an error state and is automatically cleared when a connection attempt is made.
since: 3.0
Purple.Account:remember-password
Whether or not the password for this account should be stored in the
configured PurpleCredentialProvider.
since: 3.0
Purple.Account:require-password
Whether or not this account should require a password. This is only used
if the PurpleProtocol that this account is for allows optional passwords.
since: 3.0
Properties inherited from PurpleContactInfo (17)
Purple.ContactInfo:alias
The alias for this contact. This is controlled by the libpurple user and may be used by the protocol if it allows for aliasing.
since: 3.0
Purple.ContactInfo:avatar
The avatar for this contact. This is typically controlled by the protocol and should only be read by others.
since: 3.0
Purple.ContactInfo:color
The color for this contact. This is an RGB hex code that user interfaces can use when rendering the contact. This may also be controlled via a protocol plugin in the event that the protocol allows people to set a highlight/branding color.
since: 3.0
Purple.ContactInfo:display-name
The display name for this contact. This is generally set by the person the contact is representing and controlled via the protocol plugin.
since: 3.0
Purple.ContactInfo:email
The primary email address for the contact. This may also be controlled via a protocol plugin in the event that the protocol makes it available.
since: 3.0
Purple.ContactInfo:favorite
Whether or not the contact info has been marked as a favorite or stared.
since: 3.0
Purple.ContactInfo:id
The protocol specific id for the contact.
since: 3.0
Purple.ContactInfo:name-for-display
The name that the user interface should display for this contact info.
since: 3.0
Purple.ContactInfo:note
A note for this contact. Many protocols will allow you to set a note on a contact and store it server side. This property is where that is kept track of.
since: 3.0
Purple.ContactInfo:permission
The permission level for the contact.
since: 3.0
Purple.ContactInfo:person
The PurplePerson that this contact belongs to.
since: 3.0
Purple.ContactInfo:phone-number
The primary phone number for the contact. This may also be set via a protocol plugin in the event that the protocol knows it.
since: 3.0
Purple.ContactInfo:presence
The PurplePresence for this contact. This is typically
controlled by the protocol and should only be read by others.
since: 3.0
Purple.ContactInfo:sid
The sid, or secondary id, is an additional identifier field for a contact.
since: 3.0
Purple.ContactInfo:tags
The PurpleTags for this contact.
since: 3.0
Purple.ContactInfo:time-zone
The time zone for this contact. This is typically controlled by the protocol and should only be read by others.
since: 3.0
Purple.ContactInfo:username
The username for this contact. In rare cases this can change, like when a user changes their “nick” on IRC which is their user name.
since: 3.0
Signals
Purple.Account::connected
This is emitted when the PurpleAccount:connection‘s
PurpleConnection:state has changed to
PURPLE_CONNECTION_STATE_CONNECTED.
since: 3.0
Purple.Account::disconnected
This is emitted when the PurpleAccount:connection‘s
PurpleConnection:state has changed to
PURPLE_CONNECTION_STATE_DISCONNECTED.
since: 3.0
Purple.Account::setting-changed
The ::setting-changed signal is emitted whenever an account setting is changed.
since: 3.0
Signals inherited from PurpleContactInfo (2)
PurpleContactInfo::populate-menu
Emitted in response to purple_contact_info_get_menu() being called,
so that plugins can add additional items to menu.
since: 3.0
PurpleContactInfo::presence-changed
This is a propagation of the notify signal from presence. This means
that your callback will be called when anything in the presence changes.
since: 3.0
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.