Class

PurpleAccount

Description [src]

final class Purple.Account : GObject.Object {
  /* 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.

Ancestors

Constructors

purple_account_new

Creates a new account.

Functions

purple_account_request_close

Close the account request for the given ui handle.

Instance methods

purple_accounts_delete

Deletes an account.

purple_account_add_buddies

Adds a list of buddies to the server-side buddy list.

purple_account_add_buddy

Adds a buddy to the server-side buddy list for the specified account.

purple_account_change_password

Changes the password on the specified account.

purple_account_clear_current_error

Clear an account’s current error state, resetting it to NULL.

purple_account_clear_settings

Clears all protocol-specific settings on an account.

purple_account_connect

Connects to an account.

purple_account_disconnect

Disconnects from an account.

purple_account_get_active_status

Returns the active status for this account. This looks through the PurplePresence associated with this account and returns the PurpleStatus that has its active flag set to “TRUE.” There can be only one active PurpleStatus in a PurplePresence.

purple_account_get_bool

Returns a protocol-specific boolean setting for an account.

purple_account_get_buddy_icon_path

Gets the account’s buddy icon path.

purple_account_get_connection

Returns the account’s connection.

purple_account_get_current_error

Get the error that caused the account to be disconnected, or NULL if the account is happily connected or disconnected without an error.

purple_account_get_enabled

Returns whether or not this account is enabled.

purple_account_get_id

Gets the identifier of account.

Available since: 3.0.0

purple_account_get_int

Returns a protocol-specific integer setting for an account.

purple_account_get_name_for_display

Returns a name for this account appropriate for display to the user. In order of preference: the account’s alias; the contact or buddy alias (if the account exists on its own buddy list); the connection’s display name; the account’s username.

purple_account_get_presence

Returns the account’s presence.

purple_account_get_privacy_type

Returns the account’s privacy type.

purple_account_get_private_alias

Returns the account’s private alias.

purple_account_get_protocol

Gets the PurpleProtocol instance for account.

Available since: 3.0.0

purple_account_get_protocol_id

Returns the account’s protocol ID.

purple_account_get_protocol_name

Returns the account’s protocol name.

purple_account_get_proxy_info

Returns the account’s proxy information.

purple_account_get_remember_password

Returns whether or not this account should save its password.

purple_account_get_require_password

Gets whether or not account requires a password.

Available since: 3.0.0

purple_account_get_silence_suppression

Return whether silence suppression is used during voice call.

purple_account_get_status

Returns the account status with the specified ID.

purple_account_get_status_type

Returns the account status type with the specified ID.

purple_account_get_status_type_with_primitive

Returns the account status type with the specified primitive. Note: It is possible for an account to have more than one PurpleStatusType with the same primitive. In this case, the first PurpleStatusType is returned.

purple_account_get_status_types

Returns the account’s status types.

purple_account_get_string

Returns a protocol-specific string setting for an account.

purple_account_get_user_info

Returns the account’s user information.

purple_account_get_username

Returns the account’s username.

purple_account_is_connected

Returns whether or not the account is connected.

purple_account_is_connecting

Returns whether or not the account is connecting.

purple_account_is_disconnected

Returns whether or not the account is disconnected.

purple_account_is_disconnecting

Indicates if the account is currently being disconnected.

Available since: 3.0.0

purple_account_is_status_active

Returns whether or not an account status is active.

purple_account_privacy_allow

Allow a user to send messages. If current privacy setting for the account is: PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS: The user is added to the allow-list. PURPLE_ACCOUNT_PRIVACY_DENY_USERS : The user is removed from the deny-list. PURPLE_ACCOUNT_PRIVACY_ALLOW_ALL : No changes made. PURPLE_ACCOUNT_PRIVACY_DENY_ALL : The privacy setting is changed to PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS and the user is added to the allow-list. PURPLE_ACCOUNT_PRIVACY_ALLOW_BUDDYLIST: No changes made if the user is already in the buddy-list. Otherwise the setting is changed to PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS, all the buddies are added to the allow-list, and the user is also added to the allow-list.

purple_account_privacy_check

Check the privacy-setting for a user.

purple_account_privacy_deny

Block messages from a user. If current privacy setting for the account is: PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS: The user is removed from the allow-list. PURPLE_ACCOUNT_PRIVACY_DENY_USERS: The user is added to the deny-list. PURPLE_ACCOUNT_PRIVACY_DENY_ALL: No changes made. PURPLE_ACCOUNT_PRIVACY_ALLOW_ALL: The privacy setting is changed to PURPLE_ACCOUNT_PRIVACY_DENY_USERS and the user is added to the deny-list. PURPLE_ACCOUNT_PRIVACY_ALLOW_BUDDYLIST: If the user is not in the buddy-list, then no changes made. Otherwise, the setting is changed to PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS, all the buddies are added to the allow-list, and this user is removed from the list.

purple_account_privacy_deny_add

Adds a user to the account’s deny list.

purple_account_privacy_deny_remove

Removes a user from the account’s deny list.

purple_account_privacy_get_denied

Returns the account’s deny list.

Available since: 3.0.0

purple_account_privacy_get_permitted

Returns the account’s permit list.

Available since: 3.0.0

purple_account_privacy_permit_add

Adds a user to the account’s permit list.

purple_account_privacy_permit_remove

Removes a user from the account’s permit list.

purple_account_register

Registers an account.

purple_account_register_completed

Registration of the account was completed. Calls the registration call-back set with purple_account_set_register_callback().

Available since: 3.0.0

purple_account_remove_buddies

Removes a list of buddies from the server-side buddy list.

purple_account_remove_buddy

Removes a buddy from the server-side buddy list.

purple_account_remove_group

Removes a group from the server-side buddy list.

purple_account_remove_setting

Removes an account-specific setting by name.

purple_account_request_add

Notifies the user that the account was added to a remote user’s buddy list and asks the user if they want to add the remote user to their buddy list.

purple_account_request_change_password

Requests information from the user to change the account’s password.

purple_account_request_change_user_info

Requests information from the user to change the account’s user information.

purple_account_request_close_with_account

Close account requests registered for the given PurpleAccount.

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.

purple_account_set_bool

Sets a protocol-specific boolean setting for an account.

purple_account_set_buddy_icon_path

Sets the account’s buddy icon path.

purple_account_set_connection

Sets the account’s connection.

purple_account_set_enabled

Sets whether or not this account is enabled.

purple_account_set_int

Sets a protocol-specific integer setting for an account.

purple_account_set_privacy_type

Sets the account’s privacy type.

purple_account_set_private_alias

Sets the account’s private alias.

purple_account_set_protocol_id

Sets the account’s protocol ID.

purple_account_set_proxy_info

Sets the account’s proxy information.

purple_account_set_register_callback

Sets the callback for successful registration.

purple_account_set_remember_password

Sets whether or not this account should save its password.

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.

Available since: 3.0.0

purple_account_set_silence_suppression

Sets whether silence suppression is used during voice call.

purple_account_set_status

Activates or deactivates a status.

purple_account_set_status_attrs

Activates or deactivates a status.

Available since: 3.0.0

purple_account_set_status_types

Sets the account’s status types.

purple_account_set_string

Sets a protocol-specific string setting for an account.

purple_account_set_user_info

Sets the account’s user information.

purple_account_set_username

Sets the account’s username.

purple_account_supports_offline_message

Whether the account supports sending offline messages to buddy.

purple_account_unregister

Unregisters an account (deleting it from the server).

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Purple.Account:buddy-icon-path
No description available.
Purple.Account:connection
No description available.
Purple.Account:enabled
No description available.
Purple.Account:id
No description available.
Purple.Account:private-alias
No description available.
Purple.Account:protocol-id
No description available.
Purple.Account:proxy-info
No description available.
Purple.Account:remember-password
No description available.
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.

Available since: 3.0.0

Purple.Account:user-info
No description available.
Purple.Account:username
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::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 {
  GObjectClass parent_class;
  
}
Class members
parent_class
GObjectClass
  No description available.