mirror of
https://gitlab.linphone.org/BC/public/linphone-iphone.git
synced 2026-01-18 03:28:07 +00:00
130 lines
No EOL
4.2 KiB
C
130 lines
No EOL
4.2 KiB
C
/*
|
|
vcard.h
|
|
Copyright (C) 2015 Belledonne Communications SARL
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License
|
|
as published by the Free Software Foundation; either version 2
|
|
of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef LINPHONE_VCARD_H
|
|
#define LINPHONE_VCARD_H
|
|
|
|
#include <mediastreamer2/mscommon.h>
|
|
|
|
#ifndef LINPHONE_PUBLIC
|
|
#define LINPHONE_PUBLIC MS2_PUBLIC
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/**
|
|
* @addtogroup buddy_list
|
|
* @{
|
|
*/
|
|
|
|
typedef struct _LinphoneVCard LinphoneVCard;
|
|
|
|
/**
|
|
* Creates a LinphoneVCard object that has a pointer to an empty vCard
|
|
*/
|
|
LINPHONE_PUBLIC LinphoneVCard* linphone_vcard_new(void);
|
|
|
|
/**
|
|
* Deletes a LinphoneVCard object properly
|
|
* @param[in] vCard the LinphoneVCard to destroy
|
|
*/
|
|
LINPHONE_PUBLIC void linphone_vcard_free(LinphoneVCard *vCard);
|
|
|
|
/**
|
|
* Uses belcard to parse the content of a file and returns all the vcards it contains as LinphoneVCards, or NULL if it contains none.
|
|
* @param[in] file the path to the file to parse
|
|
* @return \mslist{LinphoneVCard}
|
|
*/
|
|
LINPHONE_PUBLIC MSList* linphone_vcard_list_from_vcard4_file(const char *file);
|
|
|
|
/**
|
|
* Uses belcard to parse the content of a buffer and returns all the vcards it contains as LinphoneVCards, or NULL if it contains none.
|
|
* @param[in] buffer the buffer to parse
|
|
* @return \mslist{LinphoneVCard}
|
|
*/
|
|
LINPHONE_PUBLIC MSList* linphone_vcard_list_from_vcard4_buffer(const char *buffer);
|
|
|
|
/**
|
|
* Uses belcard to parse the content of a buffer and returns one vCard if possible, or NULL otherwise.
|
|
* @param[in] buffer the buffer to parse
|
|
* @return a LinphoneVCard if one could be parsed, or NULL otherwise
|
|
*/
|
|
LINPHONE_PUBLIC LinphoneVCard* linphone_vcard_new_from_vcard4_buffer(const char *buffer);
|
|
|
|
/**
|
|
* Returns the vCard4 representation of the LinphoneVCard.
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @return a const char * that represents the vCard
|
|
*/
|
|
LINPHONE_PUBLIC const char* linphone_vcard_as_vcard4_string(LinphoneVCard *vCard);
|
|
|
|
/**
|
|
* Sets the FN attribute of the vCard (which is mandatory).
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @param[in] name the display name to set for the vCard
|
|
*/
|
|
LINPHONE_PUBLIC void linphone_vcard_set_full_name(LinphoneVCard *vCard, const char *name);
|
|
|
|
/**
|
|
* Returns the FN attribute of the vCard, or NULL if it isn't set yet.
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @return the display name of the vCard, or NULL
|
|
*/
|
|
LINPHONE_PUBLIC const char* linphone_vcard_get_full_name(const LinphoneVCard *vCard);
|
|
|
|
/**
|
|
* Adds a SIP address in the vCard, using the IMPP property
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @param[in] sip_address the SIP address to add
|
|
*/
|
|
LINPHONE_PUBLIC void linphone_vcard_add_sip_address(LinphoneVCard *vCard, const char *sip_address);
|
|
|
|
/**
|
|
* Removes a SIP address in the vCard (if it exists), using the IMPP property
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @param[in] sip_address the SIP address to remove
|
|
*/
|
|
LINPHONE_PUBLIC void linphone_vcard_remove_sip_address(LinphoneVCard *vCard, const char *sip_address);
|
|
|
|
/**
|
|
* Edits the preferred SIP address in the vCard (or the first one), using the IMPP property
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @param[in] sip_address the new SIP address
|
|
*/
|
|
LINPHONE_PUBLIC void linphone_vcard_edit_main_sip_address(LinphoneVCard *vCard, const char *sip_address);
|
|
|
|
/**
|
|
* Returns the list of SIP addresses (as const char *) in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or NULL
|
|
* @param[in] vCard the LinphoneVCard
|
|
* @return \mslist{const char *}
|
|
*/
|
|
LINPHONE_PUBLIC MSList* linphone_vcard_get_sip_addresses(const LinphoneVCard *vCard);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif |