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

Constructors

purple_account_new

Creates a new account.

since: 2.0

Functions

purple_account_request_close

Close the account request for the given ui handle.

since: 2.0

Instance methods

purple_accounts_delete

Deletes an account.

since: 2.0

purple_account_change_password

Changes the password on the specified account.

since: 2.0

purple_account_connect

Connects to an account.

since: 2.0

purple_account_disconnect

Disconnects from an account.

since: 2.0

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_bool

Returns a protocol-specific boolean setting for an account.

since: 2.0

purple_account_get_buddy_icon_path

Gets the account’s buddy icon path.

since: 2.0

purple_account_get_connection

Returns the account’s connection.

since: 2.0

purple_account_get_contact_info

Gets the PurpleContactInfo for account.

since: 3.0

purple_account_get_enabled

Returns whether or not this account is enabled.

since: 2.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_id

Gets the id of account.

since: 3.0

purple_account_get_int

Returns a protocol-specific integer setting for an account.

since: 2.0

purple_account_get_presence

Returns the account’s presence.

since: 2.0

purple_account_get_protocol

Gets the PurpleProtocol instance for account.

since: 3.0

purple_account_get_protocol_id

Returns the account’s protocol ID.

since: 2.0

purple_account_get_protocol_name

Returns the account’s protocol name.

since: 2.0

purple_account_get_proxy_info

Returns the account’s proxy information.

since: 2.0

purple_account_get_remember_password

Returns whether or not this account should save its password.

since: 2.0

purple_account_get_require_password

Gets whether or not account requires a password.

since: 3.0

purple_account_get_string

Returns a protocol-specific string setting for an account.

since: 2.0

purple_account_get_user_info

Returns the account’s user information.

since: 2.0

purple_account_get_username

Gets the username for account.

since: 2.0

purple_account_is_connected

Returns whether or not the account is connected.

since: 2.0

purple_account_is_connecting

Returns whether or not the account is connecting.

since: 2.0

purple_account_is_disconnected

Returns whether or not the account is disconnected.

since: 2.0

purple_account_is_disconnecting

Indicates if the account is currently being disconnected.

since: 3.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_bool

Sets a protocol-specific boolean setting for an account.

since: 2.0

purple_account_set_buddy_icon_path

Sets the account’s buddy icon path.

since: 2.0

purple_account_set_connection

Sets the account’s connection.

since: 2.0

purple_account_set_enabled

Sets whether or not this account is enabled.

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_int

Sets a protocol-specific integer setting for an account.

since: 2.0

purple_account_set_protocol_id

Sets the account’s protocol ID.

since: 2.0

purple_account_set_proxy_info

Sets the account’s proxy information.

since: 2.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

purple_account_set_string

Sets a protocol-specific string setting for an account.

since: 2.0

purple_account_set_user_info

Sets the account’s user information.

since: 2.0

purple_account_set_username

Sets the username of account to username.

since: 2.0

purple_account_thaw_notify_settings

Decrements the freeze count for settings on account.

since: 3.0

Methods inherited from PurpleContactInfo (34)

Please see PurpleContactInfo for a full list of methods.

Methods inherited from GObject (43)

Please see GObject 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:connected

Whether or not the account is connected.

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:contact-info

The PurpleContactInfo for the account.

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:id

The unique identifier for the account.

since: 3.0

Purple.Account:protocol-id

The identifier of the protocol that this account is using.

since: 3.0

Purple.Account:proxy-info

The PurpleProxyInfo for this account.

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

Purple.Account:user-info

The user information or profile for the account.

since: 3.0

Purple.Account:username

The username for the account.

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:connections PurpleConnection:state has changed to PURPLE_CONNECTION_STATE_CONNECTED.

since: 3.0

Purple.Account::disconnected

This is emitted when the PurpleAccount:connections 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.

Class structure

struct PurpleAccountClass {
  PurpleContactInfoClass parent_class;
  
}
No description available.
Class members
parent_class: PurpleContactInfoClass
No description available.