Struct

PurpleStatusType

Description [src] 

struct PurpleStatusType {
  /* No available fields */
}

PurpleStatusType’s are created by each protocol. They outline the available statuses of the protocol. AIM, for example, supports an available state with an optional available message, an away state with a mandatory message, and an invisible state (which is technically “independent” of the other two, but we’ll get into that later). PurpleStatusTypes are very permanent. They are hardcoded in each protocol and will not change often. And because they are hardcoded, they do not need to be saved to any XML file.

Constructors

purple_status_type_new

Creates a new status type with some default values (saveable and not independent).

purple_status_type_new_full

Creates a new status type.

purple_status_type_new_with_attrs

Creates a new status type with attributes.

purple_status_type_new_with_attrsv

Creates a new status type with attributes.

since: 3.0.0

Functions

purple_status_type_find_with_id

Find the PurpleStatusType with the given id.

Instance methods

purple_status_type_destroy

Destroys a status type.

purple_status_type_get_attr

Returns the attribute with the specified ID.

purple_status_type_get_attrs

Returns a list of all attributes in a status type.

purple_status_type_get_id

Returns the ID of a status type.

purple_status_type_get_name

Returns the name of a status type.

purple_status_type_get_primitive

Returns the primitive type of a status type.

purple_status_type_is_available

Returns whether or not a status type is available.

purple_status_type_is_exclusive

Returns whether the status type is exclusive.

purple_status_type_is_independent

Returns whether or not the status type is independent.

purple_status_type_is_saveable

Returns whether or not the status type is saveable.

purple_status_type_is_user_settable

Returns whether or not the status type can be set or modified by the user.