libpurple/account.h

changeset 38632
4cbae4a1bac1
parent 38240
0552f69f1996
child 38634
d0e1f9cfe94b
equal deleted inserted replaced
38631:89ded010f76c 38632:4cbae4a1bac1
444 void purple_account_set_privacy_type(PurpleAccount *account, PurpleAccountPrivacyType privacy_type); 444 void purple_account_set_privacy_type(PurpleAccount *account, PurpleAccountPrivacyType privacy_type);
445 445
446 /** 446 /**
447 * purple_account_set_status_types: 447 * purple_account_set_status_types:
448 * @account: The account. 448 * @account: The account.
449 * @status_types: The list of status types. 449 * @status_types: (element-type PurpleStatusType): The list of status types.
450 * 450 *
451 * Sets the account's status types. 451 * Sets the account's status types.
452 */ 452 */
453 void purple_account_set_status_types(PurpleAccount *account, GList *status_types); 453 void purple_account_set_status_types(PurpleAccount *account, GList *status_types);
454 454
474 * purple_account_set_status_list: 474 * purple_account_set_status_list:
475 * @account: The account. 475 * @account: The account.
476 * @status_id: The ID of the status. 476 * @status_id: The ID of the status.
477 * @active: Whether @a status_id is to be activated (%TRUE) or 477 * @active: Whether @a status_id is to be activated (%TRUE) or
478 * deactivated (%FALSE). 478 * deactivated (%FALSE).
479 * @attrs: A list of <type>const char *</type> attribute names followed by 479 * @attrs: (element-type PurpleStatusAttribute): A list of <type>const char *</type> attribute names followed by
480 * <type>const char *</type> attribute values for the status. 480 * <type>const char *</type> attribute values for the status.
481 * (For example, one pair might be <literal>"message"</literal> 481 * (For example, one pair might be <literal>"message"</literal>
482 * followed by <literal>"hello, talk to me!"</literal>.) 482 * followed by <literal>"hello, talk to me!"</literal>.)
483 * 483 *
484 * Activates or deactivates a status. All changes to the statuses of 484 * Activates or deactivates a status. All changes to the statuses of
944 * purple_account_privacy_get_permitted: 944 * purple_account_privacy_get_permitted:
945 * @account: The account. 945 * @account: The account.
946 * 946 *
947 * Returns the account's permit list. 947 * Returns the account's permit list.
948 * 948 *
949 * Returns: (transfer none): A list of the permitted users 949 * Returns: (transfer none) (element-type utf8): A list of the permitted users
950 */ 950 */
951 GSList *purple_account_privacy_get_permitted(PurpleAccount *account); 951 GSList *purple_account_privacy_get_permitted(PurpleAccount *account);
952 952
953 /** 953 /**
954 * purple_account_privacy_get_denied: 954 * purple_account_privacy_get_denied:
955 * @account: The account. 955 * @account: The account.
956 * 956 *
957 * Returns the account's deny list. 957 * Returns the account's deny list.
958 * 958 *
959 * Returns: (transfer none): A list of the denied users 959 * Returns: (transfer none) (element-type utf8): A list of the denied users
960 */ 960 */
961 GSList *purple_account_privacy_get_denied(PurpleAccount *account); 961 GSList *purple_account_privacy_get_denied(PurpleAccount *account);
962 962
963 /** 963 /**
964 * purple_account_privacy_check: 964 * purple_account_privacy_check:
980 * Returns the active status for this account. This looks through 980 * Returns the active status for this account. This looks through
981 * the PurplePresence associated with this account and returns the 981 * the PurplePresence associated with this account and returns the
982 * PurpleStatus that has its active flag set to "TRUE." There can be 982 * PurpleStatus that has its active flag set to "TRUE." There can be
983 * only one active PurpleStatus in a PurplePresence. 983 * only one active PurpleStatus in a PurplePresence.
984 * 984 *
985 * Returns: The active status. 985 * Returns: (transfer none): The active status.
986 */ 986 */
987 PurpleStatus *purple_account_get_active_status(const PurpleAccount *account); 987 PurpleStatus *purple_account_get_active_status(const PurpleAccount *account);
988 988
989 /** 989 /**
990 * purple_account_get_status: 990 * purple_account_get_status:
991 * @account: The account. 991 * @account: The account.
992 * @status_id: The status ID. 992 * @status_id: The status ID.
993 * 993 *
994 * Returns the account status with the specified ID. 994 * Returns the account status with the specified ID.
995 * 995 *
996 * Returns: The status, or %NULL if it was never registered. 996 * Returns: (transfer none): The status, or %NULL if it was never registered.
997 */ 997 */
998 PurpleStatus *purple_account_get_status(const PurpleAccount *account, 998 PurpleStatus *purple_account_get_status(const PurpleAccount *account,
999 const char *status_id); 999 const char *status_id);
1000 1000
1001 /** 1001 /**
1030 * purple_account_get_presence: 1030 * purple_account_get_presence:
1031 * @account: The account. 1031 * @account: The account.
1032 * 1032 *
1033 * Returns the account's presence. 1033 * Returns the account's presence.
1034 * 1034 *
1035 * Returns: The account's presence. 1035 * Returns: (transfer none): The account's presence.
1036 */ 1036 */
1037 PurplePresence *purple_account_get_presence(const PurpleAccount *account); 1037 PurplePresence *purple_account_get_presence(const PurpleAccount *account);
1038 1038
1039 /** 1039 /**
1040 * purple_account_is_status_active: 1040 * purple_account_is_status_active:
1052 * purple_account_get_status_types: 1052 * purple_account_get_status_types:
1053 * @account: The account. 1053 * @account: The account.
1054 * 1054 *
1055 * Returns the account's status types. 1055 * Returns the account's status types.
1056 * 1056 *
1057 * Returns: (transfer none): The account's status types. 1057 * Returns: (transfer none) (element-type PurpleStatusType): The account's status types.
1058 */ 1058 */
1059 GList *purple_account_get_status_types(const PurpleAccount *account); 1059 GList *purple_account_get_status_types(const PurpleAccount *account);
1060 1060
1061 /** 1061 /**
1062 * purple_account_get_int: 1062 * purple_account_get_int:
1177 void purple_account_add_buddy(PurpleAccount *account, PurpleBuddy *buddy, const char *message); 1177 void purple_account_add_buddy(PurpleAccount *account, PurpleBuddy *buddy, const char *message);
1178 1178
1179 /** 1179 /**
1180 * purple_account_add_buddies: 1180 * purple_account_add_buddies:
1181 * @account: The account. 1181 * @account: The account.
1182 * @buddies: The list of PurpleBlistNodes representing the buddies to add. 1182 * @buddies: (element-type PurpleBuddy) The list of PurpleBlistNodes representing the buddies to add.
1183 * @message: The invite message. This may be ignored by a protocol. 1183 * @message: The invite message. This may be ignored by a protocol.
1184 * 1184 *
1185 * Adds a list of buddies to the server-side buddy list. 1185 * Adds a list of buddies to the server-side buddy list.
1186 */ 1186 */
1187 void purple_account_add_buddies(PurpleAccount *account, GList *buddies, const char *message); 1187 void purple_account_add_buddies(PurpleAccount *account, GList *buddies, const char *message);
1198 PurpleGroup *group); 1198 PurpleGroup *group);
1199 1199
1200 /** 1200 /**
1201 * purple_account_remove_buddies: 1201 * purple_account_remove_buddies:
1202 * @account: The account. 1202 * @account: The account.
1203 * @buddies: The list of buddies to remove. 1203 * @buddies: (element-type PurpleBuddy): The list of buddies to remove.
1204 * @groups: The list of groups to remove buddies from. Each node of this 1204 * @groups: (element-type PurpleGroup): The list of groups to remove buddies from. Each node of this
1205 * list should match the corresponding node of buddies. 1205 * list should match the corresponding node of buddies.
1206 * 1206 *
1207 * Removes a list of buddies from the server-side buddy list. 1207 * Removes a list of buddies from the server-side buddy list.
1208 * 1208 *
1209 * Note: The lists buddies and groups are parallel lists. Be sure that node n of 1209 * Note: The lists buddies and groups are parallel lists. Be sure that node n of

mercurial