![]() |
Delta Chat Core C-API
|
#include <deltachat.h>
Public Member Functions | |
char * | dc_contact_get_addr (const dc_contact_t *contact) |
Get email address. More... | |
uint32_t | dc_contact_get_color (const dc_contact_t *contact) |
Get a color for the contact. More... | |
char * | dc_contact_get_display_name (const dc_contact_t *contact) |
Get display name. More... | |
char * | dc_contact_get_first_name (const dc_contact_t *contact) |
Get the part of the name before the first space. More... | |
uint32_t | dc_contact_get_id (const dc_contact_t *contact) |
Get the ID of the contact. More... | |
char * | dc_contact_get_name (const dc_contact_t *contact) |
Get the contact name. More... | |
char * | dc_contact_get_name_n_addr (const dc_contact_t *contact) |
Get a summary of name and address. More... | |
char * | dc_contact_get_profile_image (const dc_contact_t *contact) |
Get the contact's profile image. More... | |
int | dc_contact_is_blocked (const dc_contact_t *contact) |
Check if a contact is blocked. More... | |
int | dc_contact_is_verified (dc_contact_t *contact) |
Check if a contact was verified. More... | |
void | dc_contact_unref (dc_contact_t *contact) |
Free a contact object. More... | |
An object representing a single contact in memory. The contact object is not updated. If you want an update, you have to recreate the object.
The library makes sure only to use names authorized by the contact in To:
or Cc:
. _Given-names _as "Daddy" or "Honey" are not used there. For this purpose, internally, two names are tracked - authorized-name and given-name. By default, these names are equal, but functions working with contact names (eg. dc_contact_get_name(), dc_contact_get_display_name(), dc_contact_get_name_n_addr(), dc_contact_get_first_name(), dc_create_contact() or dc_add_address_book()) only affect the given-name.
char * dc_contact_get_addr | ( | const dc_contact_t * | contact | ) |
Get email address.
The email address is always set for a contact.
contact | The contact object. |
uint32_t dc_contact_get_color | ( | const dc_contact_t * | contact | ) |
Get a color for the contact.
The color is calculated from the contact's email address and can be used for an fallback avatar with white initials as well as for headlines in bubbles of group chats.
contact | The contact object. |
char * dc_contact_get_display_name | ( | const dc_contact_t * | contact | ) |
Get display name.
This is the name as defined by the contact himself, modified by the user or, if both are unset, the email address.
This name is typically used in lists. To get the name editable in a formular, use dc_contact_get_name().
contact | The contact object. |
char * dc_contact_get_first_name | ( | const dc_contact_t * | contact | ) |
Get the part of the name before the first space.
In most languages, this seems to be the prename. If there is no space, the full display name is returned. If the display name is not set, the e-mail address is returned.
contact | The contact object. |
uint32_t dc_contact_get_id | ( | const dc_contact_t * | contact | ) |
Get the ID of the contact.
contact | The contact object. |
char * dc_contact_get_name | ( | const dc_contact_t * | contact | ) |
Get the contact name.
This is the name as defined by the contact himself or modified by the user. May be an empty string.
This name is typically used in a form where the user can edit the name of a contact. To get a fine name to display in lists etc., use dc_contact_get_display_name() or dc_contact_get_name_n_addr().
contact | The contact object. |
char * dc_contact_get_name_n_addr | ( | const dc_contact_t * | contact | ) |
Get a summary of name and address.
The returned string is either "Name (email@domain.com)" or just "email@domain.com" if the name is unset.
The summary is typically used when asking the user something about the contact. The attached email address makes the question unique, eg. "Chat with Alan Miller (am@uniquedomain.com)?"
contact | The contact object. |
char * dc_contact_get_profile_image | ( | const dc_contact_t * | contact | ) |
Get the contact's profile image.
This is the image set by each remote user on their own using dc_set_config(context, "selfavatar", image).
contact | The contact object. |
int dc_contact_is_blocked | ( | const dc_contact_t * | contact | ) |
Check if a contact is blocked.
To block or unblock a contact, use dc_block_contact().
contact | The contact object. |
int dc_contact_is_verified | ( | dc_contact_t * | contact | ) |
Check if a contact was verified.
E.g. by a secure-join QR code scan and if the key has not changed since this verification.
The UI may draw a checkbox or something like that beside verified contacts.
contact | The contact object. |
void dc_contact_unref | ( | dc_contact_t * | contact | ) |
Free a contact object.
contact | The contact object as created eg. by dc_get_contact(). If NULL is given, nothing is done. |