summaryrefslogtreecommitdiff
path: root/libpurple/purplecontactinfo.h
diff options
context:
space:
mode:
authorGary Kramlich <grim@reaperworld.com>2023-01-06 01:53:58 -0600
committerGary Kramlich <grim@reaperworld.com>2023-01-06 01:53:58 -0600
commit0a42d2593149e969011418484153484603105528 (patch)
tree4ab09425d5c31854b3bc923ff3e84988a48b103d /libpurple/purplecontactinfo.h
parent103289666175ea9a4a04d85ec32527bcf2e346c1 (diff)
downloadpidgin-0a42d2593149e969011418484153484603105528.tar.gz
Add a name-for-display property to PurpleContactInfo
This is a readonly property that is updated when the other properties change. I also tweaked priorities a bit, a contact info's alias is now the highest priority to allow users to set an alias on a person, but then also override it at the contact info level. The use case here is person has an alias of "Pidgy", but Pidgy's slack account is aliased to "Pidgy (work)". Testing Done: Ran the unit tests. Reviewed at https://reviews.imfreedom.org/r/2151/
Diffstat (limited to 'libpurple/purplecontactinfo.h')
-rw-r--r--libpurple/purplecontactinfo.h13
1 files changed, 2 insertions, 11 deletions
diff --git a/libpurple/purplecontactinfo.h b/libpurple/purplecontactinfo.h
index a9b94cbd5b..f0ef858521 100644
--- a/libpurple/purplecontactinfo.h
+++ b/libpurple/purplecontactinfo.h
@@ -332,17 +332,8 @@ void purple_contact_info_set_permission(PurpleContactInfo *info, PurpleContactIn
* purple_contact_info_get_name_for_display:
* @info: The instance.
*
- * Gets the name that should be displayed for @info.
- *
- * If @info is associated with a [class@Purple.Person], the value of
- * [property@Purple.Person:alias] will be returned if it is set.
- *
- * Otherwise, this will return the first set property from the following list:
- *
- * * [property@Purple.ContactInfo:alias]
- * * [property@Purple.ContactInfo:display-name]
- * * [property@Purple.ContactInfo:username]
- * * [property@Purple.ContactInfo:id]
+ * Gets the name that should be displayed for @info. See
+ * [property@Purple.ContactInfo:name-for-display] for more information.
*
* Returns: (transfer none): The name to display for @info.
*