Struct

PurpleSavedStatus

Description [src]

struct PurpleSavedStatus {
  /* No available fields */
}

Saved statuses don’t really interact much with the rest of Purple. It could really be a plugin. It’s just a list of away states. When a user chooses one of the saved states, their Purple accounts are set to the settings of that state.

In the savedstatus API, there is the concept of a ‘transient’ saved status. A transient saved status is one that is not permanent. Purple will removed it automatically if it isn’t used for a period of time. Transient saved statuses don’t have titles and they don’t show up in the list of saved statuses. In fact, if a saved status does not have a title then it is transient. If it does have a title, then it is not transient.

What good is a transient status, you ask? They can be used to keep track of the user’s 5 most recently used statuses, for example. Basically if they just set a message on the fly, we’ll cache it for them in case they want to use it again. If they don’t use it again, we’ll just delete it.

Constructors

purple_savedstatus_new

Create a new saved status. This will add the saved status to the list of saved statuses and writes the revised list to status.xml.

Functions

purple_savedstatus_delete

Delete a saved status. This removes the saved status from the list of saved statuses, and writes the revised list to status.xml.

purple_savedstatus_find

Finds a saved status with the specified title.

purple_savedstatus_find_by_creation_time

Finds a saved status with the specified creation time.

purple_savedstatus_find_transient_by_type_and_message

Finds a saved status with the specified primitive and message.

purple_savedstatus_get_current

Returns the currently selected saved status. If we are idle then this returns purple_savedstatus_get_idleaway(). Otherwise it returns purple_savedstatus_get_default().

purple_savedstatus_get_default

Returns the default saved status that is used when our accounts are not idle-away.

purple_savedstatus_get_idleaway

Returns the saved status that is used when your accounts become idle-away.

purple_savedstatus_get_startup

Returns the status to be used when purple is starting up.

purple_savedstatus_is_idleaway

Return TRUE if we are currently idle-away. Otherwise returns FALSE.

purple_savedstatus_set_idleaway

Set whether accounts in Purple are idle-away or not.

purple_savedstatus_substatus_get_message

Get the message of a given substatus.

purple_savedstatus_substatus_get_status_type

Get the status type of a given substatus.

Instance methods

purple_savedstatus_activate

Sets the statuses for all your accounts to those specified by the given saved_status. This function calls purple_savedstatus_activate_for_account() for all your accounts.

purple_savedstatus_activate_for_account

Sets the statuses for a given account to those specified by the given saved_status.

purple_savedstatus_delete_by_status

Delete a saved status. This removes the saved status from the list of saved statuses, and writes the revised list to status.xml.

purple_savedstatus_get_creation_time

Return the time in seconds-since-the-epoch when this saved status was created. Note: For any status created by Purple 1.5.0 or older this value will be invalid and very small (close to 0). This is because Purple 1.5.0 and older did not record the timestamp when the status was created.

purple_savedstatus_get_message

Return the default message of a given saved status.

purple_savedstatus_get_primitive_type

Return the type of a given saved status.

purple_savedstatus_get_substatus

Get the substatus for an account in a saved status.

purple_savedstatus_get_title

Return the name of a given saved status.

purple_savedstatus_has_substatuses

Determine if a given saved status has “substatuses,” or if it is a simple status (the same for all accounts).

purple_savedstatus_is_transient

Determines if a given saved status is “transient.” A transient saved status is one that was not explicitly added by the user. Transient statuses are automatically removed if they are not used for a period of time.

purple_savedstatus_set_message

Set the message for the given saved status.

purple_savedstatus_set_primitive_type

Set the type for the given saved status.

purple_savedstatus_set_substatus

Set a substatus for an account in a saved status.

purple_savedstatus_set_title

Set the title for the given saved status.

purple_savedstatus_unset_substatus

Unset a substatus for an account in a saved status. This clears the previously set substatus for the PurpleSavedStatus. If this saved status is activated then this account will use the default status type and message.