Liblinphone  5.1.0
Macros | Typedefs | Enumerations | Functions
Buddy list

Managing Buddies and buddy list and presence. More...

Macros

#define linphone_friend_get_send_subscribe   linphone_friend_subscribes_enabled
 
#define linphone_friend_send_subscribe   linphone_friend_enable_subscribes
 

Typedefs

typedef void(* LinphoneFriendListCbsContactCreatedCb) (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)
 Callback used to notify a new contact has been created on the CardDAV server and downloaded locally. More...
 
typedef void(* LinphoneFriendListCbsContactDeletedCb) (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)
 Callback used to notify a contact has been deleted on the CardDAV server. More...
 
typedef void(* LinphoneFriendListCbsContactUpdatedCb) (LinphoneFriendList *friend_list, LinphoneFriend *new_friend, LinphoneFriend *old_friend)
 Callback used to notify a contact has been updated on the CardDAV server. More...
 
typedef void(* LinphoneFriendListCbsSyncStateChangedCb) (LinphoneFriendList *friend_list, LinphoneFriendListSyncStatus status, const char *message)
 Callback used to notify the status of the synchronization has changed. More...
 
typedef void(* LinphoneFriendListCbsPresenceReceivedCb) (LinphoneFriendList *friend_list, const bctbx_list_t *friends)
 Callback used to notify a list with all friends that have received presence information. More...
 
typedef struct _LinphoneFriend LinphoneFriend
 This object is used to store a SIP address. More...
 
typedef enum _LinphoneFriendCapability LinphoneFriendCapability
 Enum describing the capabilities of a LinphoneFriend, populated through presence subscribe/notify process.
 
typedef struct _LinphoneFriendList LinphoneFriendList
 This object representing a list of LinphoneFriend. More...
 
typedef enum _LinphoneFriendListType LinphoneFriendListType
 The types of FriendList.
 
typedef struct _LinphoneFriendListCbs LinphoneFriendListCbs
 An object to handle the callbacks for LinphoneFriend synchronization.
 
typedef enum _LinphoneFriendListStatus LinphoneFriendListStatus
 Enum describing the status of a LinphoneFriendList operation.
 
typedef enum _LinphoneFriendListSyncStatus LinphoneFriendListSyncStatus
 Enum describing the status of a CardDAV synchronization.
 
typedef enum _LinphoneConsolidatedPresence LinphoneConsolidatedPresence
 Consolidated presence information: 'online' means the user is open for communication, 'busy' means the user is open for communication but involved in an other activity, 'do not disturb' means the user is not open for communication, and 'offline' means that no presence information is available.
 
typedef struct _LinphonePresenceActivity LinphonePresenceActivity
 Presence activity type holding information about a presence activity.
 
typedef enum LinphonePresenceActivityType LinphonePresenceActivityType
 Activities as defined in section 3.2 of RFC 4480.
 
typedef enum LinphonePresenceBasicStatus LinphonePresenceBasicStatus
 Basic status as defined in section 4.1.4 of RFC 3863.
 
typedef struct _LinphonePresenceModel LinphonePresenceModel
 Presence model type holding information about the presence of a person.
 
typedef struct _LinphonePresenceNote LinphonePresenceNote
 Presence note type holding information about a presence note.
 
typedef struct _LinphonePresencePerson LinphonePresencePerson
 Presence person holding information about a presence person.
 
typedef struct _LinphonePresenceService LinphonePresenceService
 Presence service type holding information about a presence service.
 
typedef enum _LinphoneSubscribePolicy LinphoneSubscribePolicy
 Enum controlling behavior for incoming subscription request. More...
 
typedef enum _LinphoneMagicSearchSource LinphoneMagicSearchSource
 Enum describing the search categories for Magic Search.
 
typedef enum _LinphoneMagicSearchAggregation LinphoneMagicSearchAggregation
 Enum describing how to merge LinphoneSearchResult from LinphoneMagicSearch.
 
typedef struct _LinphoneFriendPhoneNumber LinphoneFriendPhoneNumber
 Object that represents a LinphoneFriend's phone number.
 

Enumerations

enum  _LinphoneFriendCapability {
  LinphoneFriendCapabilityNone = 0,
  LinphoneFriendCapabilityGroupChat = 1 << 0,
  LinphoneFriendCapabilityLimeX3dh = 1 << 1,
  LinphoneFriendCapabilityEphemeralMessages = 1 << 2
}
 Enum describing the capabilities of a LinphoneFriend, populated through presence subscribe/notify process. More...
 
enum  _LinphoneFriendListType {
  LinphoneFriendListTypeCardDAV = 0,
  LinphoneFriendListTypeVCard4 = 1
}
 The types of FriendList.
 
enum  _LinphoneFriendListStatus {
  LinphoneFriendListOK = 0,
  LinphoneFriendListNonExistentFriend = 1,
  LinphoneFriendListInvalidFriend = 2
}
 Enum describing the status of a LinphoneFriendList operation. More...
 
enum  _LinphoneFriendListSyncStatus {
  LinphoneFriendListSyncStarted = 0,
  LinphoneFriendListSyncSuccessful = 1,
  LinphoneFriendListSyncFailure = 2
}
 Enum describing the status of a CardDAV synchronization. More...
 
enum  _LinphoneConsolidatedPresence {
  LinphoneConsolidatedPresenceOnline = 0,
  LinphoneConsolidatedPresenceBusy = 1,
  LinphoneConsolidatedPresenceDoNotDisturb = 2,
  LinphoneConsolidatedPresenceOffline = 3
}
 Consolidated presence information: 'online' means the user is open for communication, 'busy' means the user is open for communication but involved in an other activity, 'do not disturb' means the user is not open for communication, and 'offline' means that no presence information is available.
 
enum  LinphonePresenceActivityType {
  LinphonePresenceActivityAppointment = 0,
  LinphonePresenceActivityAway = 1,
  LinphonePresenceActivityBreakfast = 2,
  LinphonePresenceActivityBusy = 3,
  LinphonePresenceActivityDinner = 4,
  LinphonePresenceActivityHoliday = 5,
  LinphonePresenceActivityInTransit = 6,
  LinphonePresenceActivityLookingForWork = 7,
  LinphonePresenceActivityLunch = 8,
  LinphonePresenceActivityMeal = 9,
  LinphonePresenceActivityMeeting = 10,
  LinphonePresenceActivityOnThePhone = 11,
  LinphonePresenceActivityOther = 12,
  LinphonePresenceActivityPerformance = 13,
  LinphonePresenceActivityPermanentAbsence = 14,
  LinphonePresenceActivityPlaying = 15,
  LinphonePresenceActivityPresentation = 16,
  LinphonePresenceActivityShopping = 17,
  LinphonePresenceActivitySleeping = 18,
  LinphonePresenceActivitySpectator = 19,
  LinphonePresenceActivitySteering = 20,
  LinphonePresenceActivityTravel = 21,
  LinphonePresenceActivityTV = 22,
  LinphonePresenceActivityUnknown = 23,
  LinphonePresenceActivityVacation = 24,
  LinphonePresenceActivityWorking = 25,
  LinphonePresenceActivityWorship = 26
}
 Activities as defined in section 3.2 of RFC 4480. More...
 
enum  LinphonePresenceBasicStatus {
  LinphonePresenceBasicStatusOpen = 0,
  LinphonePresenceBasicStatusClosed = 1
}
 Basic status as defined in section 4.1.4 of RFC 3863. More...
 
enum  _LinphoneSubscribePolicy {
  LinphoneSPWait = 0,
  LinphoneSPDeny = 1,
  LinphoneSPAccept = 2
}
 Enum controlling behavior for incoming subscription request. More...
 
enum  _LinphoneMagicSearchSource {
  LinphoneMagicSearchSourceNone = 0,
  LinphoneMagicSearchSourceFriends = 1 << 0,
  LinphoneMagicSearchSourceCallLogs = 1 << 1,
  LinphoneMagicSearchSourceLdapServers = 1 << 2,
  LinphoneMagicSearchSourceChatRooms = 1 << 3,
  LinphoneMagicSearchSourceRequest = 1 << 4,
  LinphoneMagicSearchSourceAll = -1
}
 Enum describing the search categories for Magic Search. More...
 
enum  _LinphoneMagicSearchAggregation {
  LinphoneMagicSearchAggregationNone = 0,
  LinphoneMagicSearchAggregationFriend = 1
}
 Enum describing how to merge LinphoneSearchResult from LinphoneMagicSearch. More...
 

Functions

LinphoneFriendlinphone_core_create_friend (LinphoneCore *core)
 Create a default LinphoneFriend. More...
 
LinphoneFriendlinphone_core_create_friend_with_address (LinphoneCore *core, const char *address)
 Create a LinphoneFriend from the given address. More...
 
void linphone_core_set_presence_model (LinphoneCore *core, LinphonePresenceModel *presence)
 Set my presence model. More...
 
LinphonePresenceModellinphone_core_get_presence_model (const LinphoneCore *core)
 Get my presence model. More...
 
LinphoneConsolidatedPresence linphone_core_get_consolidated_presence (const LinphoneCore *core)
 Get my consolidated presence. More...
 
void linphone_core_set_consolidated_presence (LinphoneCore *core, LinphoneConsolidatedPresence presence)
 Set my consolidated presence. More...
 
void linphone_core_reject_subscriber (LinphoneCore *core, LinphoneFriend *linphone_friend)
 Black list a friend. More...
 
void linphone_core_notify_all_friends (LinphoneCore *core, LinphonePresenceModel *presence)
 Notify all friends that have subscribed. More...
 
LinphoneFriendlinphone_core_find_friend (const LinphoneCore *core, const LinphoneAddress *address)
 Search a LinphoneFriend by its address. More...
 
LinphoneFriendlinphone_core_find_friend_by_phone_number (const LinphoneCore *core, const char *phone_number)
 Search a LinphoneFriend by its phone number. More...
 
bctbx_list_t * linphone_core_find_friends (const LinphoneCore *core, const LinphoneAddress *address)
 Search all LinphoneFriend matching an address. More...
 
LinphoneFriendlinphone_core_get_friend_by_ref_key (const LinphoneCore *core, const char *key)
 Search a LinphoneFriend by its reference key. More...
 
LinphoneFriendListlinphone_core_create_friend_list (LinphoneCore *core)
 Create a new empty LinphoneFriendList object. More...
 
void linphone_core_add_friend_list (LinphoneCore *core, LinphoneFriendList *list)
 Add a friend list. More...
 
void linphone_core_remove_friend_list (LinphoneCore *core, LinphoneFriendList *list)
 Removes a friend list. More...
 
const bctbx_list_t * linphone_core_get_friends_lists (const LinphoneCore *core)
 Retrieves the list of LinphoneFriendList from the core. More...
 
LinphoneFriendListlinphone_core_get_default_friend_list (const LinphoneCore *core)
 Retrieves the first list of LinphoneFriend from the core. More...
 
LinphoneFriendListlinphone_core_get_friend_list_by_name (const LinphoneCore *core, const char *name)
 Retrieves the list of LinphoneFriend from the core that has the given display name. More...
 
void linphone_core_enable_friend_list_subscription (LinphoneCore *core, bool_t enable)
 Sets whether or not to start friend lists subscription when in foreground. More...
 
bool_t linphone_core_is_friend_list_subscription_enabled (LinphoneCore *core)
 Returns whether or not friend lists subscription are enabled. More...
 
bool_t linphone_core_friend_list_subscription_enabled (LinphoneCore *core)
 Returns whether or not friend lists subscription are enabled. More...
 
const bctbx_list_t * linphone_core_find_contacts_by_char (LinphoneCore *core, const char *filter, bool_t sip_only)
 Retrieves a list of LinphoneAddress sort and filter. More...
 
LinphonePresenceActivitylinphone_core_create_presence_activity (LinphoneCore *core, LinphonePresenceActivityType acttype, const char *description)
 Create a LinphonePresenceActivity with the given type and description. More...
 
LinphonePresenceModellinphone_core_create_presence_model (LinphoneCore *core)
 Create a default LinphonePresenceModel. More...
 
LinphonePresenceModellinphone_core_create_presence_model_with_activity (LinphoneCore *core, LinphonePresenceActivityType acttype, const char *description)
 Create a LinphonePresenceModel with the given activity type and activity description. More...
 
LinphonePresenceModellinphone_core_create_presence_model_with_activity_and_note (LinphoneCore *core, LinphonePresenceActivityType acttype, const char *description, const char *note, const char *lang)
 Create a LinphonePresenceModel with the given activity type, activity description, note content and note language. More...
 
LinphonePresenceNotelinphone_core_create_presence_note (LinphoneCore *core, const char *content, const char *lang)
 Create a LinphonePresenceNote with the given content and language. More...
 
LinphonePresencePersonlinphone_core_create_presence_person (LinphoneCore *core, const char *id)
 Create a LinphonePresencePerson with the given id. More...
 
LinphonePresenceServicelinphone_core_create_presence_service (LinphoneCore *core, const char *id, LinphonePresenceBasicStatus basic_status, const char *contact)
 Create a LinphonePresenceService with the given id, basic status and contact. More...
 
void linphone_core_notify_notify_presence_received (LinphoneCore *core, LinphoneFriend *linphone_friend)
 Notifies the upper layer that a presence status has been received by calling the appropriate callback if one has been set. More...
 
void linphone_core_notify_notify_presence_received_for_uri_or_tel (LinphoneCore *core, LinphoneFriend *linphone_friend, const char *uri_or_tel, const LinphonePresenceModel *presence_model)
 Notifies the upper layer that a presence model change has been received for the uri or telephone number given as a parameter, by calling the appropriate callback if one has been set. More...
 
void linphone_core_set_max_size_for_auto_download_incoming_files (LinphoneCore *core, int size)
 Sets the size under which incoming files in chat messages will be downloaded automatically. More...
 
int linphone_core_get_max_size_for_auto_download_incoming_files (LinphoneCore *core)
 Gets the size under which incoming files in chat messages will be downloaded automatically. More...
 
void linphone_core_set_auto_download_voice_recordings_enabled (LinphoneCore *core, bool_t auto_download_voice_recordings)
 Auto download files attach to a chat message if it's content type matches the one we use for voice recordings. More...
 
void linphone_core_enable_auto_download_voice_recordings (LinphoneCore *core, bool_t auto_download_voice_recordings)
 Auto download files attach to a chat message if it's content type matches the one we use for voice recordings. More...
 
bool_t linphone_core_is_auto_download_voice_recordings_enabled (LinphoneCore *core)
 Gets if the auto download for incoming voice recordings is enabled or not. More...
 
bool_t linphone_core_auto_download_voice_recordings_enabled (LinphoneCore *core)
 Gets if the auto download for incoming voice recordings is enabled or not. More...
 
void linphone_core_set_auto_download_icalendars_enabled (LinphoneCore *core, bool_t auto_download_icalendars)
 Auto download files attach to a chat message if it's content type matches the one we use for icalendars. More...
 
void linphone_core_enable_auto_download_icalendars (LinphoneCore *core, bool_t auto_download_icalendars)
 Auto download files attach to a chat message if it's content type matches the one we use for icalendars. More...
 
bool_t linphone_core_is_auto_download_icalendars_enabled (LinphoneCore *core)
 Gets if the auto download for incoming icalendars is enabled or not. More...
 
bool_t linphone_core_auto_download_icalendars_enabled (LinphoneCore *core)
 Gets if the auto download for incoming icalendars is enabled or not. More...
 
bool_t linphone_core_is_sender_name_hidden_in_forward_message (LinphoneCore *core)
 Returns whether or not sender name is hidden in forward message. More...
 
void linphone_core_enable_sender_name_hidden_in_forward_message (LinphoneCore *core, bool_t enable)
 Enable whether or not to hide sender name in forward message. More...
 
void linphone_core_set_record_aware_enabled (LinphoneCore *core, bool_t enable)
 Enables the record aware feature that will warn other users when recording. More...
 
void linphone_core_enable_record_aware (LinphoneCore *core, bool_t enable)
 Enables the record aware feature that will warn other users when recording. More...
 
bool_t linphone_core_is_record_aware_enabled (LinphoneCore *core)
 Gets if the record aware feature is enabled or not. More...
 
bool_t linphone_core_record_aware_enabled (LinphoneCore *core)
 Gets if the record aware feature is enabled or not. More...
 
void linphone_core_enable_auto_send_ringing (LinphoneCore *core, bool_t enable)
 Enables the automatic sending of 180 Ringing when receiving a call. More...
 
bool_t linphone_core_auto_send_ringing_enabled (LinphoneCore *core)
 Gets if the automatic sending of 180 Ringing is enabled or not. More...
 
LinphoneStatus linphone_friend_set_address (LinphoneFriend *fr, const LinphoneAddress *address)
 Set LinphoneAddress for this friend. More...
 
const LinphoneAddresslinphone_friend_get_address (const LinphoneFriend *linphone_friend)
 Get address of this friend. More...
 
void linphone_friend_add_address (LinphoneFriend *linphone_friend, const LinphoneAddress *address)
 Adds an address in this friend. More...
 
const bctbx_list_t * linphone_friend_get_addresses (const LinphoneFriend *linphone_friend)
 Returns a list of LinphoneAddress for this friend. More...
 
void linphone_friend_remove_address (LinphoneFriend *linphone_friend, const LinphoneAddress *address)
 Removes an address in this friend. More...
 
void linphone_friend_add_phone_number (LinphoneFriend *linphone_friend, const char *phone_number)
 Adds a phone number in this friend. More...
 
void linphone_friend_add_phone_number_with_label (LinphoneFriend *linphone_friend, LinphoneFriendPhoneNumber *phone_number)
 Adds a LinphoneFriendPhoneNumber to this friend. More...
 
bctbx_list_t * linphone_friend_get_phone_numbers (const LinphoneFriend *linphone_friend)
 Returns a list of phone numbers for this friend. More...
 
bctbx_list_t * linphone_friend_get_phone_numbers_with_label (const LinphoneFriend *linphone_friend)
 Returns a list of LinphoneFriendPhoneNumber for this friend. More...
 
bool_t linphone_friend_has_phone_number (const LinphoneFriend *linphone_friend, const char *phone_number)
 Returns whether a friend contains the given phone number. More...
 
void linphone_friend_remove_phone_number (LinphoneFriend *linphone_friend, const char *phone_number)
 Removes a phone number in this friend. More...
 
void linphone_friend_remove_phone_number_with_label (LinphoneFriend *linphone_friend, const LinphoneFriendPhoneNumber *phone_number)
 Removes a LinphoneFriendPhoneNumber from this friend. More...
 
LinphoneStatus linphone_friend_set_name (LinphoneFriend *linphone_friend, const char *name)
 Set the display name for this friend. More...
 
const char * linphone_friend_get_name (const LinphoneFriend *linphone_friend)
 Get the display name for this friend. More...
 
bool_t linphone_friend_subscribes_enabled (const LinphoneFriend *linphone_friend)
 get subscription flag value More...
 
LinphoneStatus linphone_friend_enable_subscribes (LinphoneFriend *fr, bool_t enable)
 Configure LinphoneFriend to subscribe to presence information. More...
 
LinphoneStatus linphone_friend_set_inc_subscribe_policy (LinphoneFriend *fr, LinphoneSubscribePolicy policy)
 Configure incoming subscription policy for this friend. More...
 
LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy (const LinphoneFriend *linphone_friend)
 get current subscription policy for this LinphoneFriend More...
 
void linphone_friend_edit (LinphoneFriend *linphone_friend)
 Starts editing a friend configuration. More...
 
void linphone_friend_done (LinphoneFriend *linphone_friend)
 Commits modification made to the friend configuration. More...
 
LinphoneSubscriptionState linphone_friend_get_subscription_state (const LinphoneFriend *linphone_friend)
 Get subscription state of a friend. More...
 
const LinphonePresenceModellinphone_friend_get_presence_model (const LinphoneFriend *linphone_friend)
 Get the presence model of a friend. More...
 
LinphoneConsolidatedPresence linphone_friend_get_consolidated_presence (const LinphoneFriend *linphone_friend)
 Get the consolidated presence of a friend. More...
 
const LinphonePresenceModellinphone_friend_get_presence_model_for_uri_or_tel (const LinphoneFriend *linphone_friend, const char *uri_or_tel)
 Get the presence model for a specific SIP URI or phone number of a friend. More...
 
void linphone_friend_set_presence_model (LinphoneFriend *linphone_friend, LinphonePresenceModel *presence)
 Set the presence model of a friend. More...
 
void linphone_friend_set_presence_model_for_uri_or_tel (LinphoneFriend *linphone_friend, const char *uri_or_tel, LinphonePresenceModel *presence)
 Set the presence model for a specific SIP URI or phone number of a friend. More...
 
bool_t linphone_friend_is_presence_received (const LinphoneFriend *linphone_friend)
 Tells whether we already received presence information for a friend. More...
 
void linphone_friend_set_user_data (LinphoneFriend *linphone_friend, void *user_data)
 Store user pointer to friend object. More...
 
void * linphone_friend_get_user_data (const LinphoneFriend *linphone_friend)
 Retrieve user data associated with friend. More...
 
BuddyInfolinphone_friend_get_info (const LinphoneFriend *linphone_friend)
 
void linphone_friend_set_ref_key (LinphoneFriend *linphone_friend, const char *key)
 Set the reference key of a friend. More...
 
const char * linphone_friend_get_ref_key (const LinphoneFriend *linphone_friend)
 Get the reference key of a friend. More...
 
bool_t linphone_friend_in_list (const LinphoneFriend *linphone_friend)
 Check that the given friend is in a friend list. More...
 
LinphoneFriendlinphone_friend_ref (LinphoneFriend *linphone_friend)
 Acquire a reference to the linphone friend. More...
 
void linphone_friend_unref (LinphoneFriend *linphone_friend)
 Release a reference to the linphone friend. More...
 
LinphoneCorelinphone_friend_get_core (const LinphoneFriend *linphone_friend)
 Returns the LinphoneCore object managing this friend, if any. More...
 
LinphoneVcardlinphone_friend_get_vcard (const LinphoneFriend *linphone_friend)
 Returns the vCard object associated to this friend, if any. More...
 
void linphone_friend_set_vcard (LinphoneFriend *linphone_friend, LinphoneVcard *vcard)
 Binds a vCard object to a friend. More...
 
bool_t linphone_friend_create_vcard (LinphoneFriend *linphone_friend, const char *name)
 Creates a vCard object associated to this friend if there isn't one yet and if the full name is available, either by the parameter or the one in the friend's SIP URI. More...
 
LinphoneFriendlinphone_friend_new_from_vcard (LinphoneVcard *vcard)
 Contructor same as linphone_friend_new() + linphone_friend_set_address() More...
 
void linphone_friend_save (LinphoneFriend *linphone_friend, LinphoneCore *core)
 Saves a friend either in database if configured, otherwise in linphonerc. More...
 
int linphone_friend_get_capabilities (const LinphoneFriend *linphone_friend)
 Returns the capabilities associated to this friend. More...
 
bool_t linphone_friend_has_capability (const LinphoneFriend *linphone_friend, const LinphoneFriendCapability capability)
 Returns whether or not a friend has a capbility. More...
 
bool_t linphone_friend_has_capability_with_version (const LinphoneFriend *linphone_friend, const LinphoneFriendCapability capability, float version)
 Returns whether or not a friend has a capbility with a given version. More...
 
bool_t linphone_friend_has_capability_with_version_or_more (const LinphoneFriend *linphone_friend, const LinphoneFriendCapability capability, float version)
 Returns whether or not a friend has a capbility with a given version or more. More...
 
float linphone_friend_get_capability_version (const LinphoneFriend *linphone_friend, const LinphoneFriendCapability capability)
 Returns the version of a friend's capbility. More...
 
void linphone_friend_remove (LinphoneFriend *linphone_friend)
 Removes a friend from it's friend list and from the rc if exists. More...
 
void linphone_friend_set_photo (LinphoneFriend *linphone_friend, const char *picture_uri)
 Sets the contact's picture URI. More...
 
const char * linphone_friend_get_photo (const LinphoneFriend *linphone_friend)
 Gets the contact's picture URI. More...
 
void linphone_friend_set_starred (LinphoneFriend *linphone_friend, bool_t is_starred)
 Sets if the friend is a user's favorite or important contact. More...
 
bool_t linphone_friend_get_starred (const LinphoneFriend *linphone_friend)
 Gets if the friend is to be considered as important for the user. More...
 
void linphone_friend_set_native_uri (LinphoneFriend *linphone_friend, const char *native_uri)
 Sets the contact's native URI. More...
 
const char * linphone_friend_get_native_uri (const LinphoneFriend *linphone_friend)
 Gets the contact's native URI. More...
 
void linphone_friend_set_organization (LinphoneFriend *linphone_friend, const char *organization)
 Sets the contact's organization. More...
 
const char * linphone_friend_get_organization (const LinphoneFriend *linphone_friend)
 Gets the contact's organization from it's vCard. More...
 
MS2_DEPRECATED LinphoneFriendlinphone_friend_new (void)
 Contructor. More...
 
MS2_DEPRECATED LinphoneFriendlinphone_friend_new_with_address (const char *addr)
 Contructor same as linphone_friend_new() + linphone_friend_set_address() More...
 
MS2_DEPRECATED void linphone_friend_destroy (LinphoneFriend *linphone_friend)
 Destroy a LinphoneFriend. More...
 
MS2_DEPRECATED LinphoneOnlineStatus linphone_friend_get_status (const LinphoneFriend *linphone_friend)
 Get the status of a friend. More...
 
LinphoneFriendListlinphone_friend_list_ref (LinphoneFriendList *friend_list)
 Acquire a reference to the friend list. More...
 
void linphone_friend_list_unref (LinphoneFriendList *friend_list)
 Release reference to the friend list. More...
 
void * linphone_friend_list_get_user_data (const LinphoneFriendList *friend_list)
 Retrieve the user pointer associated with the friend list. More...
 
void linphone_friend_list_set_user_data (LinphoneFriendList *friend_list, void *user_data)
 Assign a user pointer to the friend list. More...
 
void linphone_friend_list_set_type (LinphoneFriendList *friend_list, LinphoneFriendListType type)
 Assign a friend list type to the friend list. More...
 
LinphoneFriendListType linphone_friend_list_get_type (LinphoneFriendList *list)
 Get the type of a friend list. More...
 
const char * linphone_friend_list_get_display_name (const LinphoneFriendList *friend_list)
 Get the display name of the friend list. More...
 
void linphone_friend_list_set_display_name (LinphoneFriendList *friend_list, const char *display_name)
 Set the display name of the friend list. More...
 
const char * linphone_friend_list_get_rls_uri (const LinphoneFriendList *friend_list)
 Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence. More...
 
void linphone_friend_list_set_rls_uri (LinphoneFriendList *friend_list, const char *rls_uri)
 Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence. More...
 
const LinphoneAddresslinphone_friend_list_get_rls_address (const LinphoneFriendList *friend_list)
 Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence. More...
 
void linphone_friend_list_set_rls_address (LinphoneFriendList *friend_list, const LinphoneAddress *rls_addr)
 Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence. More...
 
LinphoneFriendListStatus linphone_friend_list_add_friend (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)
 Add a friend to a friend list. More...
 
LinphoneFriendListStatus linphone_friend_list_add_local_friend (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)
 Add a friend to a friend list. More...
 
LinphoneFriendListStatus linphone_friend_list_remove_friend (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)
 Remove a friend from a friend list. More...
 
const bctbx_list_t * linphone_friend_list_get_friends (const LinphoneFriendList *friend_list)
 Retrieves the list of LinphoneFriend from this LinphoneFriendList. More...
 
LinphoneFriendlinphone_friend_list_find_friend_by_address (const LinphoneFriendList *friend_list, const LinphoneAddress *address)
 Find a friend in the friend list using a LinphoneAddress. More...
 
LinphoneFriendlinphone_friend_list_find_friend_by_phone_number (const LinphoneFriendList *friend_list, const char *phone_number)
 Find a friend in the friend list using a phone number. More...
 
bctbx_list_t * linphone_friend_list_find_friends_by_address (const LinphoneFriendList *friend_list, const LinphoneAddress *address)
 Find all friends in the friend list using a LinphoneAddress. More...
 
LinphoneFriendlinphone_friend_list_find_friend_by_uri (const LinphoneFriendList *friend_list, const char *uri)
 Find a friend in the friend list using an URI string. More...
 
bctbx_list_t * linphone_friend_list_find_friends_by_uri (const LinphoneFriendList *friend_list, const char *uri)
 Find all friends in the friend list using an URI string. More...
 
LinphoneFriendlinphone_friend_list_find_friend_by_ref_key (const LinphoneFriendList *friend_list, const char *ref_key)
 Find a friend in the friend list using a ref key. More...
 
void linphone_friend_list_update_subscriptions (LinphoneFriendList *friend_list)
 Update presence subscriptions for the entire list. More...
 
void linphone_friend_list_notify_presence (LinphoneFriendList *friend_list, LinphonePresenceModel *presence)
 Notify our presence to all the friends in the friend list that have subscribed to our presence directly (not using a RLS). More...
 
const char * linphone_friend_list_get_uri (const LinphoneFriendList *friend_list)
 Get the URI associated with the friend list. More...
 
void linphone_friend_list_set_uri (LinphoneFriendList *friend_list, const char *uri)
 Set the URI associated with the friend list. More...
 
bool_t linphone_friend_list_is_subscription_bodyless (LinphoneFriendList *friend_list)
 Get wheter the subscription of the friend list is bodyless or not. More...
 
void linphone_friend_list_set_subscription_bodyless (LinphoneFriendList *friend_list, bool_t bodyless)
 Set wheter the subscription of the friend list is bodyless or not. More...
 
void linphone_friend_list_update_revision (LinphoneFriendList *friend_list, int revision)
 Sets the revision from the last synchronization. More...
 
void linphone_friend_list_add_callbacks (LinphoneFriendList *friend_list, LinphoneFriendListCbs *cbs)
 Adds the LinphoneFriendListCbs object associated with a LinphoneFriendList. More...
 
void linphone_friend_list_remove_callbacks (LinphoneFriendList *friend_list, LinphoneFriendListCbs *cbs)
 Removes the LinphoneFriendListCbs object associated with a LinphoneFriendList. More...
 
LinphoneFriendListCbslinphone_friend_list_get_current_callbacks (const LinphoneFriendList *friend_list)
 Get the current LinphoneFriendListCbs object associated with a LinphoneFriendList. More...
 
LinphoneFriendListCbslinphone_friend_list_cbs_ref (LinphoneFriendListCbs *cbs)
 Acquire a reference to a LinphoneFriendListCbs object. More...
 
void linphone_friend_list_cbs_unref (LinphoneFriendListCbs *cbs)
 Release a reference to a LinphoneFriendListCbs object. More...
 
void * linphone_friend_list_cbs_get_user_data (const LinphoneFriendListCbs *cbs)
 Retrieve the user pointer associated with a LinphoneFriendListCbs object. More...
 
void linphone_friend_list_cbs_set_user_data (LinphoneFriendListCbs *cbs, void *user_data)
 Assign a user pointer to a LinphoneFriendListCbs object. More...
 
LinphoneFriendListCbsContactCreatedCb linphone_friend_list_cbs_get_contact_created (const LinphoneFriendListCbs *cbs)
 Get the contact created callback. More...
 
void linphone_friend_list_cbs_set_contact_created (LinphoneFriendListCbs *cbs, LinphoneFriendListCbsContactCreatedCb cb)
 Set the contact created callback. More...
 
LinphoneFriendListCbsContactDeletedCb linphone_friend_list_cbs_get_contact_deleted (const LinphoneFriendListCbs *cbs)
 Get the contact deleted callback. More...
 
void linphone_friend_list_cbs_set_contact_deleted (LinphoneFriendListCbs *cbs, LinphoneFriendListCbsContactDeletedCb cb)
 Set the contact deleted callback. More...
 
LinphoneFriendListCbsContactUpdatedCb linphone_friend_list_cbs_get_contact_updated (const LinphoneFriendListCbs *cbs)
 Get the contact updated callback. More...
 
void linphone_friend_list_cbs_set_contact_updated (LinphoneFriendListCbs *cbs, LinphoneFriendListCbsContactUpdatedCb cb)
 Set the contact updated callback. More...
 
LinphoneFriendListCbsSyncStateChangedCb linphone_friend_list_cbs_get_sync_status_changed (const LinphoneFriendListCbs *cbs)
 Get the sync status changed callback. More...
 
void linphone_friend_list_cbs_set_sync_status_changed (LinphoneFriendListCbs *cbs, LinphoneFriendListCbsSyncStateChangedCb cb)
 Set the contact updated callback. More...
 
LinphoneFriendListCbsPresenceReceivedCb linphone_friend_list_cbs_get_presence_received (const LinphoneFriendListCbs *cbs)
 Get the presence received callback. More...
 
void linphone_friend_list_cbs_set_presence_received (LinphoneFriendListCbs *cbs, LinphoneFriendListCbsPresenceReceivedCb cb)
 Set the presence received callback. More...
 
void linphone_friend_list_synchronize_friends_from_server (LinphoneFriendList *friend_list)
 Starts a CardDAV synchronization using value set using linphone_friend_list_set_uri. More...
 
void linphone_friend_list_update_dirty_friends (LinphoneFriendList *friend_list)
 Goes through all the LinphoneFriend that are dirty and does a CardDAV PUT to update the server. More...
 
LinphoneCorelinphone_friend_list_get_core (const LinphoneFriendList *friend_list)
 Returns the LinphoneCore object attached to this LinphoneFriendList. More...
 
int linphone_friend_list_import_friends_from_vcard4_file (LinphoneFriendList *friend_list, const char *vcard_file)
 Creates and adds LinphoneFriend objects to LinphoneFriendList from a file that contains the vCard(s) to parse. More...
 
int linphone_friend_list_import_friends_from_vcard4_buffer (LinphoneFriendList *friend_list, const char *vcard_buffer)
 Creates and adds LinphoneFriend objects to LinphoneFriendList from a buffer that contains the vCard(s) to parse. More...
 
void linphone_friend_list_export_friends_as_vcard4_file (LinphoneFriendList *friend_list, const char *vcard_file)
 Creates and export LinphoneFriend objects from LinphoneFriendList to a file using vCard 4 format. More...
 
void linphone_friend_list_enable_subscriptions (LinphoneFriendList *friend_list, bool_t enabled)
 Enable subscription to NOTIFYes of all friends list. More...
 
bool_t linphone_friend_list_subscriptions_enabled (LinphoneFriendList *friend_list)
 Gets whether subscription to NOTIFYes of all friends list are enabled or not. More...
 
MS2_DEPRECATED LinphoneFriendListCbslinphone_friend_list_get_callbacks (const LinphoneFriendList *friend_list)
 Get the LinphoneFriendListCbs object associated with a LinphoneFriendList. More...
 
LinphonePresenceModellinphone_presence_model_new_with_activity (LinphonePresenceActivityType activity, const char *description)
 Creates a presence model specifying an activity. More...
 
LinphonePresenceModellinphone_presence_model_new_with_activity_and_note (LinphonePresenceActivityType activity, const char *description, const char *note, const char *lang)
 Creates a presence model specifying an activity and adding a note. More...
 
LinphonePresenceBasicStatus linphone_presence_model_get_basic_status (const LinphonePresenceModel *model)
 Gets the basic status of a presence model. More...
 
LinphoneStatus linphone_presence_model_set_basic_status (LinphonePresenceModel *model, LinphonePresenceBasicStatus basic_status)
 Sets the basic status of a presence model. More...
 
time_t linphone_presence_model_get_timestamp (const LinphonePresenceModel *model)
 Gets the timestamp of a presence model. More...
 
char * linphone_presence_model_get_contact (const LinphonePresenceModel *model)
 Gets the contact of a presence model. More...
 
LinphoneStatus linphone_presence_model_set_contact (LinphonePresenceModel *model, const char *contact)
 Sets the contact of a presence model. More...
 
LinphoneStatus linphone_presence_model_set_presentity (LinphonePresenceModel *model, const LinphoneAddress *presentity)
 Sets the presentity of a presence model. More...
 
const LinphoneAddresslinphone_presence_model_get_presentity (const LinphonePresenceModel *model)
 Gets the presentity of a presence model. More...
 
LinphonePresenceActivitylinphone_presence_model_get_activity (const LinphonePresenceModel *model)
 Gets the first activity of a presence model (there is usually only one). More...
 
LinphoneStatus linphone_presence_model_set_activity (LinphonePresenceModel *model, LinphonePresenceActivityType activity, const char *description)
 Sets the activity of a presence model (limits to only one activity). More...
 
unsigned int linphone_presence_model_get_nb_activities (const LinphonePresenceModel *model)
 Gets the number of activities included in the presence model. More...
 
LinphonePresenceActivitylinphone_presence_model_get_nth_activity (const LinphonePresenceModel *model, unsigned int index)
 Gets the nth activity of a presence model. More...
 
LinphoneStatus linphone_presence_model_add_activity (LinphonePresenceModel *model, LinphonePresenceActivity *activity)
 Adds an activity to a presence model. More...
 
LinphoneStatus linphone_presence_model_clear_activities (LinphonePresenceModel *model)
 Clears the activities of a presence model. More...
 
LinphonePresenceNotelinphone_presence_model_get_note (const LinphonePresenceModel *model, const char *lang)
 Gets the first note of a presence model (there is usually only one). More...
 
LinphoneStatus linphone_presence_model_add_note (LinphonePresenceModel *model, const char *note_content, const char *lang)
 Adds a note to a presence model. More...
 
LinphoneStatus linphone_presence_model_clear_notes (LinphonePresenceModel *model)
 Clears all the notes of a presence model. More...
 
LinphoneConsolidatedPresence linphone_presence_model_get_consolidated_presence (const LinphonePresenceModel *model)
 Get the consolidated presence from a presence model. More...
 
LinphonePresenceModellinphone_presence_model_new (void)
 Creates a default presence model. More...
 
unsigned int linphone_presence_model_get_nb_services (const LinphonePresenceModel *model)
 Gets the number of services included in the presence model. More...
 
LinphonePresenceServicelinphone_presence_model_get_nth_service (const LinphonePresenceModel *model, unsigned int index)
 Gets the nth service of a presence model. More...
 
LinphoneStatus linphone_presence_model_add_service (LinphonePresenceModel *model, LinphonePresenceService *service)
 Adds a service to a presence model. More...
 
LinphoneStatus linphone_presence_model_clear_services (LinphonePresenceModel *model)
 Clears the services of a presence model. More...
 
unsigned int linphone_presence_model_get_nb_persons (const LinphonePresenceModel *model)
 Gets the number of persons included in the presence model. More...
 
LinphonePresencePersonlinphone_presence_model_get_nth_person (const LinphonePresenceModel *model, unsigned int index)
 Gets the nth person of a presence model. More...
 
LinphoneStatus linphone_presence_model_add_person (LinphonePresenceModel *model, LinphonePresencePerson *person)
 Adds a person to a presence model. More...
 
LinphoneStatus linphone_presence_model_clear_persons (LinphonePresenceModel *model)
 Clears the persons of a presence model. More...
 
bool_t linphone_presence_model_is_online (const LinphonePresenceModel *model)
 Tells whether a presence model is considered online. More...
 
char * linphone_presence_basic_status_to_string (LinphonePresenceBasicStatus basic_status)
 Gets the string representation of a presence basic status. More...
 
LinphonePresenceServicelinphone_presence_service_new (const char *id, LinphonePresenceBasicStatus basic_status, const char *contact)
 Creates a presence service. More...
 
char * linphone_presence_service_get_id (const LinphonePresenceService *service)
 Gets the id of a presence service. More...
 
LinphoneStatus linphone_presence_service_set_id (LinphonePresenceService *service, const char *id)
 Sets the id of a presence service. More...
 
LinphonePresenceBasicStatus linphone_presence_service_get_basic_status (const LinphonePresenceService *service)
 Gets the basic status of a presence service. More...
 
LinphoneStatus linphone_presence_service_set_basic_status (LinphonePresenceService *service, LinphonePresenceBasicStatus basic_status)
 Sets the basic status of a presence service. More...
 
char * linphone_presence_service_get_contact (const LinphonePresenceService *service)
 Gets the contact of a presence service. More...
 
LinphoneStatus linphone_presence_service_set_contact (LinphonePresenceService *service, const char *contact)
 Sets the contact of a presence service. More...
 
bctbx_list_t * linphone_presence_service_get_service_descriptions (const LinphonePresenceService *service)
 Gets the service descriptions of a presence service. More...
 
LinphoneStatus linphone_presence_service_set_service_descriptions (LinphonePresenceService *service, bctbx_list_t *descriptions)
 Sets the service descriptions of a presence service. More...
 
unsigned int linphone_presence_service_get_nb_notes (const LinphonePresenceService *service)
 Gets the number of notes included in the presence service. More...
 
LinphonePresenceNotelinphone_presence_service_get_nth_note (const LinphonePresenceService *service, unsigned int index)
 Gets the nth note of a presence service. More...
 
LinphoneStatus linphone_presence_service_add_note (LinphonePresenceService *service, LinphonePresenceNote *note)
 Adds a note to a presence service. More...
 
LinphoneStatus linphone_presence_service_clear_notes (LinphonePresenceService *service)
 Clears the notes of a presence service. More...
 
LinphonePresencePersonlinphone_presence_person_new (const char *id)
 Creates a presence person. More...
 
char * linphone_presence_person_get_id (const LinphonePresencePerson *person)
 Gets the id of a presence person. More...
 
LinphoneStatus linphone_presence_person_set_id (LinphonePresencePerson *person, const char *id)
 Sets the id of a presence person. More...
 
unsigned int linphone_presence_person_get_nb_activities (const LinphonePresencePerson *person)
 Gets the number of activities included in the presence person. More...
 
LinphonePresenceActivitylinphone_presence_person_get_nth_activity (const LinphonePresencePerson *person, unsigned int index)
 Gets the nth activity of a presence person. More...
 
LinphoneStatus linphone_presence_person_add_activity (LinphonePresencePerson *person, LinphonePresenceActivity *activity)
 Adds an activity to a presence person. More...
 
LinphoneStatus linphone_presence_person_clear_activities (LinphonePresencePerson *person)
 Clears the activities of a presence person. More...
 
unsigned int linphone_presence_person_get_nb_notes (const LinphonePresencePerson *person)
 Gets the number of notes included in the presence person. More...
 
LinphonePresenceNotelinphone_presence_person_get_nth_note (const LinphonePresencePerson *person, unsigned int index)
 Gets the nth note of a presence person. More...
 
LinphoneStatus linphone_presence_person_add_note (LinphonePresencePerson *person, LinphonePresenceNote *note)
 Adds a note to a presence person. More...
 
LinphoneStatus linphone_presence_person_clear_notes (LinphonePresencePerson *person)
 Clears the notes of a presence person. More...
 
unsigned int linphone_presence_person_get_nb_activities_notes (const LinphonePresencePerson *person)
 Gets the number of activities notes included in the presence person. More...
 
LinphonePresenceNotelinphone_presence_person_get_nth_activities_note (const LinphonePresencePerson *person, unsigned int index)
 Gets the nth activities note of a presence person. More...
 
LinphoneStatus linphone_presence_person_add_activities_note (LinphonePresencePerson *person, LinphonePresenceNote *note)
 Adds an activities note to a presence person. More...
 
LinphoneStatus linphone_presence_person_clear_activities_notes (LinphonePresencePerson *person)
 Clears the activities notes of a presence person. More...
 
LinphonePresenceActivitylinphone_presence_activity_new (LinphonePresenceActivityType acttype, const char *description)
 Creates a presence activity. More...
 
char * linphone_presence_activity_to_string (const LinphonePresenceActivity *activity)
 Gets the string representation of a presence activity. More...
 
LinphonePresenceActivityType linphone_presence_activity_get_type (const LinphonePresenceActivity *activity)
 Gets the activity type of a presence activity. More...
 
LinphoneStatus linphone_presence_activity_set_type (LinphonePresenceActivity *activity, LinphonePresenceActivityType acttype)
 Sets the type of activity of a presence activity. More...
 
const char * linphone_presence_activity_get_description (const LinphonePresenceActivity *activity)
 Gets the description of a presence activity. More...
 
LinphoneStatus linphone_presence_activity_set_description (LinphonePresenceActivity *activity, const char *description)
 Sets the description of a presence activity. More...
 
LinphonePresenceNotelinphone_presence_note_new (const char *content, const char *lang)
 Creates a presence note. More...
 
const char * linphone_presence_note_get_content (const LinphonePresenceNote *note)
 Gets the content of a presence note. More...
 
LinphoneStatus linphone_presence_note_set_content (LinphonePresenceNote *note, const char *content)
 Sets the content of a presence note. More...
 
const char * linphone_presence_note_get_lang (const LinphonePresenceNote *note)
 Gets the language of a presence note. More...
 
LinphoneStatus linphone_presence_note_set_lang (LinphonePresenceNote *note, const char *lang)
 Sets the language of a presence note. More...
 
LinphonePresenceModellinphone_presence_model_ref (LinphonePresenceModel *model)
 Increase the reference count of the LinphonePresenceModel object. More...
 
LinphonePresenceModellinphone_presence_model_unref (LinphonePresenceModel *model)
 Decrease the reference count of the LinphonePresenceModel object and destroy it if it reaches 0. More...
 
void linphone_presence_model_set_user_data (LinphonePresenceModel *model, void *user_data)
 Sets the user data of a LinphonePresenceModel object. More...
 
void * linphone_presence_model_get_user_data (const LinphonePresenceModel *model)
 Gets the user data of a LinphonePresenceModel object. More...
 
int linphone_presence_model_get_capabilities (const LinphonePresenceModel *model)
 Gets the capabilities of a LinphonePresenceModel object. More...
 
bool_t linphone_presence_model_has_capability (const LinphonePresenceModel *model, const LinphoneFriendCapability capability)
 Returns whether or not the LinphonePresenceModel object has a given capability. More...
 
bool_t linphone_presence_model_has_capability_with_version (const LinphonePresenceModel *model, const LinphoneFriendCapability capability, float version)
 Returns whether or not the LinphonePresenceModel object has a given capability with a certain version. More...
 
bool_t linphone_presence_model_has_capability_with_version_or_more (const LinphonePresenceModel *model, const LinphoneFriendCapability capability, float version)
 Returns whether or not the LinphonePresenceModel object has a given capability with a certain version or more. More...
 
float linphone_presence_model_get_capability_version (const LinphonePresenceModel *model, const LinphoneFriendCapability capability)
 Returns the version of the capability of a LinphonePresenceModel. More...
 
LinphonePresenceServicelinphone_presence_service_ref (LinphonePresenceService *service)
 Increase the reference count of the LinphonePresenceService object. More...
 
LinphonePresenceServicelinphone_presence_service_unref (LinphonePresenceService *service)
 Decrease the reference count of the LinphonePresenceService object and destroy it if it reaches 0. More...
 
void linphone_presence_service_set_user_data (LinphonePresenceService *service, void *user_data)
 Sets the user data of a LinphonePresenceService object. More...
 
void * linphone_presence_service_get_user_data (const LinphonePresenceService *service)
 Gets the user data of a LinphonePresenceService object. More...
 
LinphonePresencePersonlinphone_presence_person_ref (LinphonePresencePerson *person)
 Increase the reference count of the LinphonePresencePerson object. More...
 
LinphonePresencePersonlinphone_presence_person_unref (LinphonePresencePerson *person)
 Decrease the reference count of the LinphonePresencePerson object and destroy it if it reaches 0. More...
 
void linphone_presence_person_set_user_data (LinphonePresencePerson *person, void *user_data)
 Sets the user data of a LinphonePresencePerson object. More...
 
void * linphone_presence_person_get_user_data (const LinphonePresencePerson *person)
 Gets the user data of a LinphonePresencePerson object. More...
 
LinphonePresenceActivitylinphone_presence_activity_ref (LinphonePresenceActivity *activity)
 Increase the reference count of the LinphonePresenceActivity object. More...
 
LinphonePresenceActivitylinphone_presence_activity_unref (LinphonePresenceActivity *activity)
 Decrease the reference count of the LinphonePresenceActivity object and destroy it if it reaches 0. More...
 
void linphone_presence_activity_set_user_data (LinphonePresenceActivity *activity, void *user_data)
 Sets the user data of a LinphonePresenceActivity object. More...
 
void * linphone_presence_activity_get_user_data (const LinphonePresenceActivity *activity)
 Gets the user data of a LinphonePresenceActivity object. More...
 
LinphonePresenceNotelinphone_presence_note_ref (LinphonePresenceNote *note)
 Increase the reference count of the LinphonePresenceNote object. More...
 
LinphonePresenceNotelinphone_presence_note_unref (LinphonePresenceNote *note)
 Decrease the reference count of the LinphonePresenceNote object and destroy it if it reaches 0. More...
 
void linphone_presence_note_set_user_data (LinphonePresenceNote *note, void *user_data)
 Sets the user data of a LinphonePresenceNote object. More...
 
void * linphone_presence_note_get_user_data (const LinphonePresenceNote *note)
 Gets the user data of a LinphonePresenceNote object. More...
 
LinphoneFriendPhoneNumberlinphone_friend_phone_number_new (const char *phone_number, const char *label)
 Creates a new LinphoneFriendPhoneNumber. More...
 
LinphoneFriendPhoneNumberlinphone_friend_phone_number_clone (const LinphoneFriendPhoneNumber *phone_number)
 Clones a phone number. More...
 
LinphoneFriendPhoneNumberlinphone_friend_phone_number_ref (LinphoneFriendPhoneNumber *phone_number)
 Takes a reference on a LinphoneFriendPhoneNumber. More...
 
void linphone_friend_phone_number_unref (LinphoneFriendPhoneNumber *phone_number)
 Releases a LinphoneFriendPhoneNumber. More...
 
void linphone_friend_phone_number_set_phone_number (LinphoneFriendPhoneNumber *phone_number, const char *number)
 Sets the phone number. More...
 
const char * linphone_friend_phone_number_get_phone_number (const LinphoneFriendPhoneNumber *phone_number)
 Gets the phone number. More...
 
void linphone_friend_phone_number_set_label (LinphoneFriendPhoneNumber *phone_number, const char *label)
 Sets the label for this phone number. More...
 
const char * linphone_friend_phone_number_get_label (const LinphoneFriendPhoneNumber *phone_number)
 Gets the label associated to this phone number. More...
 

Detailed Description

Managing Buddies and buddy list and presence.

Buddies and buddy list
Each buddy is represented by a LinphoneFriend object created by function linphone_friend_new(). Buddy configuration parameters like sip uri or status publication policy for this * friend are configurable for each buddy.
Here under a typical buddy creation:

LinphoneFriend* my_friend=linphone_core_create_friend_with_address("sip:joe@sip.linphone.org"); /*creates friend object for buddy joe*/
linphone_friend_enable_subscribes(my_friend,TRUE); /*configure this friend to emit SUBSCRIBE message after being added to LinphoneCore*/
linphone_friend_set_inc_subscribe_policy(my_friend,LinphoneSPAccept); /* accept Incoming subscription request for this friend*/

friends status changes are reported by callback LinphoneCoreVTable.notify_presence_recv

static void notify_presence_recv_updated (struct _LinphoneCore *lc, LinphoneFriend *friend) {
const LinphoneAddress* friend_address = linphone_friend_get_address(friend);
printf("New state state [%s] for user id [%s] \n"
,linphone_online_status_to_string(linphone_friend_get_status(friend))
,linphone_address_as_string (friend_address));
}


Once created a buddy can be added to the buddy list using function linphone_core_add_friend() . Added friends will be notified about local status changes
Any subsequente modifications to LinphoneFriend must be first started by a call to function linphone_friend_edit() and validated by function linphone_friend_done()

linphone_friend_edit(my_friend); /* start editing friend */
linphone_friend_enable_subscribes(my_friend,FALSE); /*disable subscription for this friend*/
linphone_friend_done(my_friend); /*commit changes triggering an UNSUBSCRIBE message*/

Publishing presence status
Local presence status can be changed using function linphone_core_set_presence_model() .New status is propagated to all friends previously added to LinphoneCore.

Handling incoming subscription request
New incoming subscription requests are process according to the incoming subscription policy state for subscription initiated by members of the buddy list.
For incoming request comming from an unknown buddy, the call back LinphoneCoreVTable.new_subscription_request is invoked.


A complete tutorial can be found at : Registration tutorial

Typedef Documentation

◆ LinphoneFriend

typedef struct _LinphoneFriend LinphoneFriend

This object is used to store a SIP address.

LinphoneFriend is mainly used to implement an adressbook feature, and are used as data for the LinphoneMagicSearch object. If your proxy supports it, you can also use it to subscribe to presence information.

The objects are stored in a LinphoneFriendList which are in turn stored inside the LinphoneCore. They can be stored inside a database if the path to it is configured, otherwise they will be lost after the LinphoneCore is destroyed.

Thanks to the vCard plugin, you can also store more information like phone numbers, organization, etc...

◆ LinphoneFriendList

typedef struct _LinphoneFriendList LinphoneFriendList

This object representing a list of LinphoneFriend.

You can use it to store contacts locally or synchronize them through CardDAV protocol.

◆ LinphoneFriendListCbsContactCreatedCb

typedef void(* LinphoneFriendListCbsContactCreatedCb) (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)

Callback used to notify a new contact has been created on the CardDAV server and downloaded locally.

Parameters
friend_listThe LinphoneFriendList object the new contact is added to
linphone_friendThe LinphoneFriend object that has been created

◆ LinphoneFriendListCbsContactDeletedCb

typedef void(* LinphoneFriendListCbsContactDeletedCb) (LinphoneFriendList *friend_list, LinphoneFriend *linphone_friend)

Callback used to notify a contact has been deleted on the CardDAV server.

Parameters
friend_listThe LinphoneFriendList object a contact has been removed from
linphone_friendThe LinphoneFriend object that has been deleted

◆ LinphoneFriendListCbsContactUpdatedCb

typedef void(* LinphoneFriendListCbsContactUpdatedCb) (LinphoneFriendList *friend_list, LinphoneFriend *new_friend, LinphoneFriend *old_friend)

Callback used to notify a contact has been updated on the CardDAV server.

Parameters
friend_listThe LinphoneFriendList object in which a contact has been updated
new_friendThe new LinphoneFriend object corresponding to the updated contact
old_friendThe old LinphoneFriend object before update

◆ LinphoneFriendListCbsPresenceReceivedCb

typedef void(* LinphoneFriendListCbsPresenceReceivedCb) (LinphoneFriendList *friend_list, const bctbx_list_t *friends)

Callback used to notify a list with all friends that have received presence information.

Parameters
friend_listThe LinphoneFriendList object for which the status has changed
friendsA of the relevant friends

◆ LinphoneFriendListCbsSyncStateChangedCb

typedef void(* LinphoneFriendListCbsSyncStateChangedCb) (LinphoneFriendList *friend_list, LinphoneFriendListSyncStatus status, const char *message)

Callback used to notify the status of the synchronization has changed.

Parameters
friend_listThe LinphoneFriendList object for which the status has changed
statusThe new LinphoneFriendListSyncStatus
messageAn additional information on the status update

◆ LinphoneSubscribePolicy

Enum controlling behavior for incoming subscription request.

Use by linphone_friend_set_inc_subscribe_policy()

Enumeration Type Documentation

◆ _LinphoneFriendCapability

Enum describing the capabilities of a LinphoneFriend, populated through presence subscribe/notify process.

Enumerator
LinphoneFriendCapabilityNone 

No capabilities populated.

LinphoneFriendCapabilityGroupChat 

This friend can be invited in a Flexisip backend LinphoneChatRoom.

LinphoneFriendCapabilityLimeX3dh 

This friend can be invited in a Flexisip backend end-to-end encrypted LinphoneChatRoom.

LinphoneFriendCapabilityEphemeralMessages 

This friend is able to delete ephemeral messages once they have expired.

◆ _LinphoneFriendListStatus

Enum describing the status of a LinphoneFriendList operation.

Enumerator
LinphoneFriendListOK 

Operation went fine.

LinphoneFriendListNonExistentFriend 

LinphoneFriend wasn't found in the LinphoneFriendList

LinphoneFriendListInvalidFriend 

LinphoneFriend is already present in a LinphoneFriendList

◆ _LinphoneFriendListSyncStatus

Enum describing the status of a CardDAV synchronization.

Enumerator
LinphoneFriendListSyncStarted 

Synchronization started.

LinphoneFriendListSyncSuccessful 

Synchronization finished successfuly.

LinphoneFriendListSyncFailure 

Synchronization failed.

◆ _LinphoneMagicSearchAggregation

Enum describing how to merge LinphoneSearchResult from LinphoneMagicSearch.

Enumerator
LinphoneMagicSearchAggregationNone 

No aggregation is done, you can have multiple SearchResult with the same Friend.

LinphoneMagicSearchAggregationFriend 

Aggregation is done by friend, you will have at most a SearchResult per Friend.

◆ _LinphoneMagicSearchSource

Enum describing the search categories for Magic Search.

Enumerator
LinphoneMagicSearchSourceNone 

no Source specified.

If requested in search, the list should be empty

LinphoneMagicSearchSourceFriends 

Search in friends only.

LinphoneMagicSearchSourceCallLogs 

Search in Call Logs.

LinphoneMagicSearchSourceLdapServers 

Search in LDAP servers.

LinphoneMagicSearchSourceChatRooms 

Search in Chat rooms participants.

LinphoneMagicSearchSourceRequest 

Search from request : it is usually an address built from the request.

LinphoneMagicSearchSourceAll 

Search in all sources.

◆ _LinphoneSubscribePolicy

Enum controlling behavior for incoming subscription request.

Use by linphone_friend_set_inc_subscribe_policy()

Enumerator
LinphoneSPWait 

Does not automatically accept an incoming subscription request.

This policy implies that a decision has to be taken for each incoming subscription request notified by callback LinphoneCoreVTable.new_subscription_requested

LinphoneSPDeny 

Rejects incoming subscription request.

LinphoneSPAccept 

Automatically accepts a subscription request.

◆ LinphonePresenceActivityType

Activities as defined in section 3.2 of RFC 4480.

Enumerator
LinphonePresenceActivityAppointment 

The person has a calendar appointment, without specifying exactly of what type.

This activity is indicated if more detailed information is not available or the person chooses not to reveal more information.

LinphonePresenceActivityAway 

The person is physically away from all interactive communication devices.

LinphonePresenceActivityBreakfast 

The person is eating the first meal of the day, usually eaten in the morning.

LinphonePresenceActivityBusy 

The person is busy, without further details.

LinphonePresenceActivityDinner 

The person is having his or her main meal of the day, eaten in the evening or at midday.

LinphonePresenceActivityHoliday 

This is a scheduled national or local holiday.

LinphonePresenceActivityInTransit 

The person is riding in a vehicle, such as a car, but not steering.

LinphonePresenceActivityLookingForWork 

The person is looking for (paid) work.

LinphonePresenceActivityLunch 

The person is eating his or her midday meal.

LinphonePresenceActivityMeal 

The person is scheduled for a meal, without specifying whether it is breakfast, lunch, or dinner, or some other meal.

LinphonePresenceActivityMeeting 

The person is in an assembly or gathering of people, as for a business, social, or religious purpose.

A meeting is a sub-class of an appointment.

LinphonePresenceActivityOnThePhone 

The person is talking on the telephone.

LinphonePresenceActivityOther 

The person is engaged in an activity with no defined representation.

A string describing the activity in plain text SHOULD be provided.

LinphonePresenceActivityPerformance 

A performance is a sub-class of an appointment and includes musical, theatrical, and cinematic performances as well as lectures.

It is distinguished from a meeting by the fact that the person may either be lecturing or be in the audience, with a potentially large number of other people, making interruptions particularly noticeable.

LinphonePresenceActivityPermanentAbsence 

The person will not return for the foreseeable future, e.g., because it is no longer working for the company.

LinphonePresenceActivityPlaying 

The person is occupying himself or herself in amusement, sport, or other recreation.

LinphonePresenceActivityPresentation 

The person is giving a presentation, lecture, or participating in a formal round-table discussion.

LinphonePresenceActivityShopping 

The person is visiting stores in search of goods or services.

LinphonePresenceActivitySleeping 

The person is sleeping.

LinphonePresenceActivitySpectator 

The person is observing an event, such as a sports event.

LinphonePresenceActivitySteering 

The person is controlling a vehicle, watercraft, or plane.

LinphonePresenceActivityTravel 

The person is on a business or personal trip, but not necessarily in-transit.

LinphonePresenceActivityTV 

The person is watching television.

LinphonePresenceActivityUnknown 

The activity of the person is unknown.

LinphonePresenceActivityVacation 

A period of time devoted to pleasure, rest, or relaxation.

LinphonePresenceActivityWorking 

The person is engaged in, typically paid, labor, as part of a profession or job.

LinphonePresenceActivityWorship 

The person is participating in religious rites.

◆ LinphonePresenceBasicStatus

Basic status as defined in section 4.1.4 of RFC 3863.

Enumerator
LinphonePresenceBasicStatusOpen 

This value means that the associated contact element, if any, is ready to accept communication.

LinphonePresenceBasicStatusClosed 

This value means that the associated contact element, if any, is unable to accept communication.

Function Documentation

◆ linphone_core_add_friend_list()

void linphone_core_add_friend_list ( LinphoneCore core,
LinphoneFriendList list 
)

Add a friend list.

Parameters
coreLinphoneCore object
listLinphoneFriendList object

◆ linphone_core_auto_download_icalendars_enabled()

bool_t linphone_core_auto_download_icalendars_enabled ( LinphoneCore core)

Gets if the auto download for incoming icalendars is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if icalendars will be automatically downloaded, FALSE otherwise.

◆ linphone_core_auto_download_voice_recordings_enabled()

bool_t linphone_core_auto_download_voice_recordings_enabled ( LinphoneCore core)

Gets if the auto download for incoming voice recordings is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if voice recordings will be automatically downloaded, FALSE otherwise.

◆ linphone_core_auto_send_ringing_enabled()

bool_t linphone_core_auto_send_ringing_enabled ( LinphoneCore core)

Gets if the automatic sending of 180 Ringing is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if the automatic sending of 180 Ringing is enabled, FALSE otherwise.

◆ linphone_core_create_friend()

LinphoneFriend* linphone_core_create_friend ( LinphoneCore core)

Create a default LinphoneFriend.

Parameters
coreLinphoneCore object
Returns
The created LinphoneFriend object

◆ linphone_core_create_friend_list()

LinphoneFriendList* linphone_core_create_friend_list ( LinphoneCore core)

Create a new empty LinphoneFriendList object.

Parameters
coreLinphoneCore object.
Returns
A new LinphoneFriendList object.

◆ linphone_core_create_friend_with_address()

LinphoneFriend* linphone_core_create_friend_with_address ( LinphoneCore core,
const char *  address 
)

Create a LinphoneFriend from the given address.

Parameters
coreLinphoneCore object
addressA string containing the address to create the LinphoneFriend from
Returns
The created LinphoneFriend object.

◆ linphone_core_create_presence_activity()

LinphonePresenceActivity* linphone_core_create_presence_activity ( LinphoneCore core,
LinphonePresenceActivityType  acttype,
const char *  description 
)

Create a LinphonePresenceActivity with the given type and description.

Parameters
coreLinphoneCore object.
acttypeThe LinphonePresenceActivityType to set for the activity.
descriptionAn additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
Returns
The created LinphonePresenceActivity object.

◆ linphone_core_create_presence_model()

LinphonePresenceModel* linphone_core_create_presence_model ( LinphoneCore core)

Create a default LinphonePresenceModel.

Parameters
coreLinphoneCore object.
Returns
The created LinphonePresenceModel object.

◆ linphone_core_create_presence_model_with_activity()

LinphonePresenceModel* linphone_core_create_presence_model_with_activity ( LinphoneCore core,
LinphonePresenceActivityType  acttype,
const char *  description 
)

Create a LinphonePresenceModel with the given activity type and activity description.

Parameters
coreLinphoneCore object.
acttypeThe LinphonePresenceActivityType to set for the activity of the created model.
descriptionAn additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
Returns
The created LinphonePresenceModel object.

◆ linphone_core_create_presence_model_with_activity_and_note()

LinphonePresenceModel* linphone_core_create_presence_model_with_activity_and_note ( LinphoneCore core,
LinphonePresenceActivityType  acttype,
const char *  description,
const char *  note,
const char *  lang 
)

Create a LinphonePresenceModel with the given activity type, activity description, note content and note language.

Parameters
coreLinphoneCore object.
acttypeThe LinphonePresenceActivityType to set for the activity of the created model.
descriptionAn additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
noteThe content of the note to be added to the created model.
langThe language of the note to be added to the created model.
Returns
The created LinphonePresenceModel object.

◆ linphone_core_create_presence_note()

LinphonePresenceNote* linphone_core_create_presence_note ( LinphoneCore core,
const char *  content,
const char *  lang 
)

Create a LinphonePresenceNote with the given content and language.

Parameters
coreLinphoneCore object.
contentThe content of the note to be created.
langThe language of the note to be created.
Returns
The created LinphonePresenceNote object.

◆ linphone_core_create_presence_person()

LinphonePresencePerson* linphone_core_create_presence_person ( LinphoneCore core,
const char *  id 
)

Create a LinphonePresencePerson with the given id.

Parameters
coreLinphoneCore object
idThe id of the person to be created.
Returns
The created LinphonePresencePerson object.

◆ linphone_core_create_presence_service()

LinphonePresenceService* linphone_core_create_presence_service ( LinphoneCore core,
const char *  id,
LinphonePresenceBasicStatus  basic_status,
const char *  contact 
)

Create a LinphonePresenceService with the given id, basic status and contact.

Parameters
coreLinphoneCore object.
idThe id of the service to be created.
basic_statusThe basic status of the service to be created.
contactA string containing a contact information corresponding to the service to be created.
Returns
The created LinphonePresenceService object.

◆ linphone_core_enable_auto_download_icalendars()

void linphone_core_enable_auto_download_icalendars ( LinphoneCore core,
bool_t  auto_download_icalendars 
)

Auto download files attach to a chat message if it's content type matches the one we use for icalendars.

Parameters
coreLinphoneCore object
auto_download_icalendarsTRUE to automatically download incoming icalendars, FALSE to disable it.

◆ linphone_core_enable_auto_download_voice_recordings()

void linphone_core_enable_auto_download_voice_recordings ( LinphoneCore core,
bool_t  auto_download_voice_recordings 
)

Auto download files attach to a chat message if it's content type matches the one we use for voice recordings.

Parameters
coreLinphoneCore object
auto_download_voice_recordingsTRUE to automatically download incoming voice recordings, FALSE to disable it.

◆ linphone_core_enable_auto_send_ringing()

void linphone_core_enable_auto_send_ringing ( LinphoneCore core,
bool_t  enable 
)

Enables the automatic sending of 180 Ringing when receiving a call.

Parameters
coreLinphoneCore object
enableTRUE to activate the automatic 180 Ringing, FALSE to disable it.

◆ linphone_core_enable_friend_list_subscription()

void linphone_core_enable_friend_list_subscription ( LinphoneCore core,
bool_t  enable 
)

Sets whether or not to start friend lists subscription when in foreground.

Parameters
coreThe LinphoneCore
enablewhether or not to enable the feature

◆ linphone_core_enable_record_aware()

void linphone_core_enable_record_aware ( LinphoneCore core,
bool_t  enable 
)

Enables the record aware feature that will warn other users when recording.

Parameters
coreLinphoneCore object
enableTRUE to activate the record aware feature, FALSE to disable it.

◆ linphone_core_enable_sender_name_hidden_in_forward_message()

void linphone_core_enable_sender_name_hidden_in_forward_message ( LinphoneCore core,
bool_t  enable 
)

Enable whether or not to hide sender name in forward message.

Parameters
coreThe LinphoneCore
enablewhether or not to enable the feature

◆ linphone_core_find_contacts_by_char()

const bctbx_list_t* linphone_core_find_contacts_by_char ( LinphoneCore core,
const char *  filter,
bool_t  sip_only 
)

Retrieves a list of LinphoneAddress sort and filter.

Parameters
coreLinphoneCore object
filterChars used for the filter*
sip_onlyOnly sip address or not
Returns
A list of filtered LinphoneAddress + the LinphoneAddress created with the filter.

◆ linphone_core_find_friend()

LinphoneFriend* linphone_core_find_friend ( const LinphoneCore core,
const LinphoneAddress address 
)

Search a LinphoneFriend by its address.

Parameters
coreLinphoneCore object.
addressThe LinphoneAddress to use to search the friend.
Returns
The LinphoneFriend object corresponding to the given address or NULL if not found.

◆ linphone_core_find_friend_by_phone_number()

LinphoneFriend* linphone_core_find_friend_by_phone_number ( const LinphoneCore core,
const char *  phone_number 
)

Search a LinphoneFriend by its phone number.

Parameters
coreLinphoneCore object.
phone_numberThe phone number to use to search the friend.
Returns
The LinphoneFriend object corresponding to the given phone number or NULL if not found.

◆ linphone_core_find_friends()

bctbx_list_t* linphone_core_find_friends ( const LinphoneCore core,
const LinphoneAddress address 
)

Search all LinphoneFriend matching an address.

Parameters
coreLinphoneCore object.
addressThe address to use to search the friends.
Returns
A list of LinphoneFriend corresponding to the given address.

◆ linphone_core_friend_list_subscription_enabled()

bool_t linphone_core_friend_list_subscription_enabled ( LinphoneCore core)

Returns whether or not friend lists subscription are enabled.

Parameters
coreThe LinphoneCore
Returns
whether or not the feature is enabled

◆ linphone_core_get_consolidated_presence()

LinphoneConsolidatedPresence linphone_core_get_consolidated_presence ( const LinphoneCore core)

Get my consolidated presence.

Parameters
coreLinphoneCore object
Returns
My LinphoneConsolidatedPresence presence

◆ linphone_core_get_default_friend_list()

LinphoneFriendList* linphone_core_get_default_friend_list ( const LinphoneCore core)

Retrieves the first list of LinphoneFriend from the core.

Parameters
coreLinphoneCore object
Returns
the first LinphoneFriendList object or NULL.

◆ linphone_core_get_friend_by_ref_key()

LinphoneFriend* linphone_core_get_friend_by_ref_key ( const LinphoneCore core,
const char *  key 
)

Search a LinphoneFriend by its reference key.

Parameters
coreLinphoneCore object.
keyThe reference key to use to search the friend.
Returns
The LinphoneFriend object corresponding to the given reference key.

◆ linphone_core_get_friend_list_by_name()

LinphoneFriendList* linphone_core_get_friend_list_by_name ( const LinphoneCore core,
const char *  name 
)

Retrieves the list of LinphoneFriend from the core that has the given display name.

Parameters
coreLinphoneCore object
namethe name of the list
Returns
the first LinphoneFriendList object or NULL.

◆ linphone_core_get_friends_lists()

const bctbx_list_t* linphone_core_get_friends_lists ( const LinphoneCore core)

Retrieves the list of LinphoneFriendList from the core.

Parameters
coreLinphoneCore object
Returns
A list of LinphoneFriendList.

◆ linphone_core_get_max_size_for_auto_download_incoming_files()

int linphone_core_get_max_size_for_auto_download_incoming_files ( LinphoneCore core)

Gets the size under which incoming files in chat messages will be downloaded automatically.

Parameters
coreLinphoneCore object
Returns
The size in bytes, -1 if autodownload feature is disabled, 0 to download them all no matter the size

◆ linphone_core_get_presence_model()

LinphonePresenceModel* linphone_core_get_presence_model ( const LinphoneCore core)

Get my presence model.

Parameters
coreLinphoneCore object
Returns
A LinphonePresenceModel object, or NULL if no presence model has been set.

◆ linphone_core_is_auto_download_icalendars_enabled()

bool_t linphone_core_is_auto_download_icalendars_enabled ( LinphoneCore core)

Gets if the auto download for incoming icalendars is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if icalendars will be automatically downloaded, FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_core_auto_download_icalendars_enabled() instead.

◆ linphone_core_is_auto_download_voice_recordings_enabled()

bool_t linphone_core_is_auto_download_voice_recordings_enabled ( LinphoneCore core)

Gets if the auto download for incoming voice recordings is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if voice recordings will be automatically downloaded, FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_core_auto_download_voice_recordings_enabled() instead.

◆ linphone_core_is_friend_list_subscription_enabled()

bool_t linphone_core_is_friend_list_subscription_enabled ( LinphoneCore core)

Returns whether or not friend lists subscription are enabled.

Parameters
coreThe LinphoneCore
Returns
whether or not the feature is enabled
Deprecated:
16/12/2021 Use linphone_core_friend_list_subscription_enabled() instead.

◆ linphone_core_is_record_aware_enabled()

bool_t linphone_core_is_record_aware_enabled ( LinphoneCore core)

Gets if the record aware feature is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if the record aware feature is enabled, FALSE otherwise.
Deprecated:
16/12/2021 Use linphone_core_record_aware_enabled() instead.

◆ linphone_core_is_sender_name_hidden_in_forward_message()

bool_t linphone_core_is_sender_name_hidden_in_forward_message ( LinphoneCore core)

Returns whether or not sender name is hidden in forward message.

Parameters
coreThe LinphoneCore
Returns
whether or not the feature

◆ linphone_core_notify_all_friends()

void linphone_core_notify_all_friends ( LinphoneCore core,
LinphonePresenceModel presence 
)

Notify all friends that have subscribed.

Parameters
coreLinphoneCore object
presenceLinphonePresenceModel to notify

◆ linphone_core_notify_notify_presence_received()

void linphone_core_notify_notify_presence_received ( LinphoneCore core,
LinphoneFriend linphone_friend 
)

Notifies the upper layer that a presence status has been received by calling the appropriate callback if one has been set.

This method is for advanced usage, where customization of the liblinphone's internal behavior is required.

Parameters
corethe LinphoneCore object.
linphone_friendthe LinphoneFriend whose presence information has been received.

◆ linphone_core_notify_notify_presence_received_for_uri_or_tel()

void linphone_core_notify_notify_presence_received_for_uri_or_tel ( LinphoneCore core,
LinphoneFriend linphone_friend,
const char *  uri_or_tel,
const LinphonePresenceModel presence_model 
)

Notifies the upper layer that a presence model change has been received for the uri or telephone number given as a parameter, by calling the appropriate callback if one has been set.

This method is for advanced usage, where customization of the liblinphone's internal behavior is required.

Parameters
corethe LinphoneCore object.
linphone_friendthe LinphoneFriend whose presence information has been received.
uri_or_teltelephone number or sip uri
presence_modelthe LinphonePresenceModel that has been modified

◆ linphone_core_record_aware_enabled()

bool_t linphone_core_record_aware_enabled ( LinphoneCore core)

Gets if the record aware feature is enabled or not.

Parameters
coreLinphoneCore object
Returns
TRUE if the record aware feature is enabled, FALSE otherwise.

◆ linphone_core_reject_subscriber()

void linphone_core_reject_subscriber ( LinphoneCore core,
LinphoneFriend linphone_friend 
)

Black list a friend.

same as linphone_friend_set_inc_subscribe_policy() with LinphoneSPDeny policy;

Parameters
coreLinphoneCore object
linphone_friendLinphoneFriend to reject

◆ linphone_core_remove_friend_list()

void linphone_core_remove_friend_list ( LinphoneCore core,
LinphoneFriendList list 
)

Removes a friend list.

Parameters
coreLinphoneCore object
listLinphoneFriendList object

◆ linphone_core_set_auto_download_icalendars_enabled()

void linphone_core_set_auto_download_icalendars_enabled ( LinphoneCore core,
bool_t  auto_download_icalendars 
)

Auto download files attach to a chat message if it's content type matches the one we use for icalendars.

Parameters
coreLinphoneCore object
auto_download_icalendarsTRUE to automatically download incoming icalendars, FALSE to disable it.
Deprecated:
16/12/2021 Use linphone_core_enable_auto_download_icalendars() instead.

◆ linphone_core_set_auto_download_voice_recordings_enabled()

void linphone_core_set_auto_download_voice_recordings_enabled ( LinphoneCore core,
bool_t  auto_download_voice_recordings 
)

Auto download files attach to a chat message if it's content type matches the one we use for voice recordings.

Parameters
coreLinphoneCore object
auto_download_voice_recordingsTRUE to automatically download incoming voice recordings, FALSE to disable it.
Deprecated:
16/12/2021 Use linphone_core_enable_auto_download_voice_recordings() instead.

◆ linphone_core_set_consolidated_presence()

void linphone_core_set_consolidated_presence ( LinphoneCore core,
LinphoneConsolidatedPresence  presence 
)

Set my consolidated presence.

Parameters
coreLinphoneCore object
presenceLinphoneConsolidatedPresence value

◆ linphone_core_set_max_size_for_auto_download_incoming_files()

void linphone_core_set_max_size_for_auto_download_incoming_files ( LinphoneCore core,
int  size 
)

Sets the size under which incoming files in chat messages will be downloaded automatically.

Parameters
coreLinphoneCore object
sizeThe size in bytes, -1 to disable the autodownload feature, 0 to download them all no matter the size

◆ linphone_core_set_presence_model()

void linphone_core_set_presence_model ( LinphoneCore core,
LinphonePresenceModel presence 
)

Set my presence model.

Parameters
coreLinphoneCore object
presenceLinphonePresenceModel

◆ linphone_core_set_record_aware_enabled()

void linphone_core_set_record_aware_enabled ( LinphoneCore core,
bool_t  enable 
)

Enables the record aware feature that will warn other users when recording.

Parameters
coreLinphoneCore object
enableTRUE to activate the record aware feature, FALSE to disable it.
Deprecated:
16/12/2021 Use linphone_core_enable_record_aware() instead.

◆ linphone_friend_add_address()

void linphone_friend_add_address ( LinphoneFriend linphone_friend,
const LinphoneAddress address 
)

Adds an address in this friend.

Parameters
linphone_friendLinphoneFriend object
addressLinphoneAddress object

◆ linphone_friend_add_phone_number()

void linphone_friend_add_phone_number ( LinphoneFriend linphone_friend,
const char *  phone_number 
)

Adds a phone number in this friend.

Parameters
linphone_friendLinphoneFriend object
phone_numbernumber to add

◆ linphone_friend_add_phone_number_with_label()

void linphone_friend_add_phone_number_with_label ( LinphoneFriend linphone_friend,
LinphoneFriendPhoneNumber phone_number 
)

Adds a LinphoneFriendPhoneNumber to this friend.

Parameters
linphone_friendLinphoneFriend object
phone_numberthe LinphoneFriendPhoneNumber to add

◆ linphone_friend_create_vcard()

bool_t linphone_friend_create_vcard ( LinphoneFriend linphone_friend,
const char *  name 
)

Creates a vCard object associated to this friend if there isn't one yet and if the full name is available, either by the parameter or the one in the friend's SIP URI.

Parameters
linphone_friendLinphoneFriend object
nameThe full name of the friend or NULL to use the one from the friend's SIP URI
Returns
TRUE if the vCard has been created, FALSE if it wasn't possible (for exemple if name and the friend's SIP URI are null or if the friend's SIP URI doesn't have a display name), or if there is already one vcard

◆ linphone_friend_destroy()

MS2_DEPRECATED void linphone_friend_destroy ( LinphoneFriend linphone_friend)

Destroy a LinphoneFriend.

Parameters
linphone_friendLinphoneFriend object
Deprecated:
31/03/2015 Use linphone_friend_unref() instead.

◆ linphone_friend_done()

void linphone_friend_done ( LinphoneFriend linphone_friend)

Commits modification made to the friend configuration.

Parameters
linphone_friendLinphoneFriend object

◆ linphone_friend_edit()

void linphone_friend_edit ( LinphoneFriend linphone_friend)

Starts editing a friend configuration.

Because friend configuration must be consistent, applications MUST call linphone_friend_edit() before doing any attempts to modify friend configuration (such as linphone_friend_set_address() or linphone_friend_set_inc_subscribe_policy()). Once the modifications are done, then the application must call linphone_friend_done() to commit the changes.

Parameters
linphone_friendLinphoneFriend object

◆ linphone_friend_enable_subscribes()

LinphoneStatus linphone_friend_enable_subscribes ( LinphoneFriend fr,
bool_t  enable 
)

Configure LinphoneFriend to subscribe to presence information.

Parameters
linphone_friendLinphoneFriend object
enableif TRUE this friend will receive subscription message
Returns
0

◆ linphone_friend_get_address()

const LinphoneAddress* linphone_friend_get_address ( const LinphoneFriend linphone_friend)

Get address of this friend.

Note
the LinphoneAddress object returned is hold by the LinphoneFriend, however calling several time this function may return different objects.
Parameters
linphone_friendLinphoneFriend object
Returns
the LinphoneAddress.

◆ linphone_friend_get_addresses()

const bctbx_list_t* linphone_friend_get_addresses ( const LinphoneFriend linphone_friend)

Returns a list of LinphoneAddress for this friend.

Parameters
linphone_friendLinphoneFriend object
Returns
A list of LinphoneAddress.

◆ linphone_friend_get_capabilities()

int linphone_friend_get_capabilities ( const LinphoneFriend linphone_friend)

Returns the capabilities associated to this friend.

Parameters
linphone_friendLinphoneFriend object
Returns
an int representing the capabilities of the friend

◆ linphone_friend_get_capability_version()

float linphone_friend_get_capability_version ( const LinphoneFriend linphone_friend,
const LinphoneFriendCapability  capability 
)

Returns the version of a friend's capbility.

Parameters
linphone_friendLinphoneFriend object
capabilityLinphoneFriendCapability object
Returns
the version of a friend's capbility.

◆ linphone_friend_get_consolidated_presence()

LinphoneConsolidatedPresence linphone_friend_get_consolidated_presence ( const LinphoneFriend linphone_friend)

Get the consolidated presence of a friend.

Parameters
linphone_friendLinphoneFriend object
Returns
The LinphoneConsolidatedPresence of the friend

◆ linphone_friend_get_core()

LinphoneCore* linphone_friend_get_core ( const LinphoneFriend linphone_friend)

Returns the LinphoneCore object managing this friend, if any.

Parameters
linphone_friendLinphoneFriend object
Returns
the LinphoneCore object associated.

◆ linphone_friend_get_inc_subscribe_policy()

LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy ( const LinphoneFriend linphone_friend)

get current subscription policy for this LinphoneFriend

Parameters
linphone_friendLinphoneFriend object
Returns
the LinphoneSubscribePolicy enum

◆ linphone_friend_get_name()

const char* linphone_friend_get_name ( const LinphoneFriend linphone_friend)

Get the display name for this friend.

Parameters
linphone_friendLinphoneFriend object
Returns
The display name of this friend.

◆ linphone_friend_get_native_uri()

const char* linphone_friend_get_native_uri ( const LinphoneFriend linphone_friend)

Gets the contact's native URI.

Parameters
linphone_friendthe LinphoneFriend object.
Returns
the native URI set if any, NULL otherwise.

◆ linphone_friend_get_organization()

const char* linphone_friend_get_organization ( const LinphoneFriend linphone_friend)

Gets the contact's organization from it's vCard.

It's a shortcut to linphone_friend_get_vcard() and linphone_vcard_get_organization().

Parameters
linphone_friendthe LinphoneFriend object.
Returns
the organization set if any & vCard is available, NULL otherwise.

◆ linphone_friend_get_phone_numbers()

bctbx_list_t* linphone_friend_get_phone_numbers ( const LinphoneFriend linphone_friend)

Returns a list of phone numbers for this friend.

Parameters
linphone_friendLinphoneFriend object
Returns
A list of phone numbers as string.

◆ linphone_friend_get_phone_numbers_with_label()

bctbx_list_t* linphone_friend_get_phone_numbers_with_label ( const LinphoneFriend linphone_friend)

Returns a list of LinphoneFriendPhoneNumber for this friend.

Parameters
linphone_friendLinphoneFriend object
Returns
A list of phone numbers as string.

◆ linphone_friend_get_photo()

const char* linphone_friend_get_photo ( const LinphoneFriend linphone_friend)

Gets the contact's picture URI.

Parameters
linphone_friendthe LinphoneFriend object.
Returns
the picture URI set if any, NULL otherwise.

◆ linphone_friend_get_presence_model()

const LinphonePresenceModel* linphone_friend_get_presence_model ( const LinphoneFriend linphone_friend)

Get the presence model of a friend.

Parameters
linphone_friendA LinphoneFriend object
Returns
A LinphonePresenceModel object, or NULL if the friend do not have presence information (in which case he is considered offline).

◆ linphone_friend_get_presence_model_for_uri_or_tel()

const LinphonePresenceModel* linphone_friend_get_presence_model_for_uri_or_tel ( const LinphoneFriend linphone_friend,
const char *  uri_or_tel 
)

Get the presence model for a specific SIP URI or phone number of a friend.

Parameters
linphone_friendA LinphoneFriend object
uri_or_telThe SIP URI or phone number for which to get the presence model
Returns
A LinphonePresenceModel object, or NULL if the friend do not have presence information for this SIP URI or phone number.

◆ linphone_friend_get_ref_key()

const char* linphone_friend_get_ref_key ( const LinphoneFriend linphone_friend)

Get the reference key of a friend.

Parameters
linphone_friendLinphoneFriend object.
Returns
The reference key of the friend.

◆ linphone_friend_get_starred()

bool_t linphone_friend_get_starred ( const LinphoneFriend linphone_friend)

Gets if the friend is to be considered as important for the user.

Parameters
linphone_friendthe LinphoneFriend object.
Returns
TRUE if the contact is a user's favorite, FALSE otherwise.

◆ linphone_friend_get_status()

MS2_DEPRECATED LinphoneOnlineStatus linphone_friend_get_status ( const LinphoneFriend linphone_friend)

Get the status of a friend.

Parameters
lfA LinphoneFriend object
Returns
#LinphoneOnlineStatus
Deprecated:
19/06/2013 Use linphone_friend_get_presence_model() instead

◆ linphone_friend_get_subscription_state()

LinphoneSubscriptionState linphone_friend_get_subscription_state ( const LinphoneFriend linphone_friend)

Get subscription state of a friend.

Parameters
linphone_friendA LinphoneFriend object
Returns
the LinphoneSubscriptionState enum

◆ linphone_friend_get_user_data()

void* linphone_friend_get_user_data ( const LinphoneFriend linphone_friend)

Retrieve user data associated with friend.

Parameters
linphone_friendA LinphoneFriend object
Returns
the user data pointer.

◆ linphone_friend_get_vcard()

LinphoneVcard* linphone_friend_get_vcard ( const LinphoneFriend linphone_friend)

Returns the vCard object associated to this friend, if any.

Parameters
linphone_friendLinphoneFriend object
Returns
the LinphoneVcard or NULL.

◆ linphone_friend_has_capability()

bool_t linphone_friend_has_capability ( const LinphoneFriend linphone_friend,
const LinphoneFriendCapability  capability 
)

Returns whether or not a friend has a capbility.

Parameters
linphone_friendLinphoneFriend object
capabilityLinphoneFriendCapability object
Returns
whether or not a friend has a capbility

◆ linphone_friend_has_capability_with_version()

bool_t linphone_friend_has_capability_with_version ( const LinphoneFriend linphone_friend,
const LinphoneFriendCapability  capability,
float  version 
)

Returns whether or not a friend has a capbility with a given version.

Parameters
linphone_friendLinphoneFriend object
capabilityLinphoneFriendCapability object
versionthe version to test
Returns
whether or not a friend has a capbility with a given version or -1.0 if friend has not capability.

◆ linphone_friend_has_capability_with_version_or_more()

bool_t linphone_friend_has_capability_with_version_or_more ( const LinphoneFriend linphone_friend,
const LinphoneFriendCapability  capability,
float  version 
)

Returns whether or not a friend has a capbility with a given version or more.

Parameters
linphone_friendLinphoneFriend object
capabilityLinphoneFriendCapability object
versionthe version to test
Returns
whether or not a friend has a capbility with a given version or more.

◆ linphone_friend_has_phone_number()

bool_t linphone_friend_has_phone_number ( const LinphoneFriend linphone_friend,
const char *  phone_number 
)

Returns whether a friend contains the given phone number.

Parameters
linphone_friendLinphoneFriend object
phone_numberthe phone number to search for
Returns
TRUE if found, FALSE otherwise

◆ linphone_friend_in_list()

bool_t linphone_friend_in_list ( const LinphoneFriend linphone_friend)

Check that the given friend is in a friend list.

Parameters
linphone_friendLinphoneFriend object.
Returns
TRUE if the friend is in a friend list, FALSE otherwise.

◆ linphone_friend_is_presence_received()

bool_t linphone_friend_is_presence_received ( const LinphoneFriend linphone_friend)

Tells whether we already received presence information for a friend.

Parameters
linphone_friendA LinphoneFriend object
Returns
TRUE if presence information has been received for the friend, FALSE otherwise.

◆ linphone_friend_list_add_callbacks()

void linphone_friend_list_add_callbacks ( LinphoneFriendList friend_list,
LinphoneFriendListCbs cbs 
)

Adds the LinphoneFriendListCbs object associated with a LinphoneFriendList.

Parameters
friend_listLinphoneFriendList object
cbsThe current LinphoneFriendListCbs object to be added to the LinphoneFriendList.

◆ linphone_friend_list_add_friend()

LinphoneFriendListStatus linphone_friend_list_add_friend ( LinphoneFriendList friend_list,
LinphoneFriend linphone_friend 
)

Add a friend to a friend list.

If or when a remote CardDAV server will be attached to the list, the friend will be sent to the server.

Parameters
friend_listLinphoneFriendList object.
linphone_friendLinphoneFriend object to add to the friend list.
Returns
LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.

◆ linphone_friend_list_add_local_friend()

LinphoneFriendListStatus linphone_friend_list_add_local_friend ( LinphoneFriendList friend_list,
LinphoneFriend linphone_friend 
)

Add a friend to a friend list.

The friend will never be sent to a remote CardDAV server. Warning! #LinphoneFriends added this way will be removed on the next synchronization, and the callback contact_deleted will be called.

Parameters
friend_listLinphoneFriendList object.
linphone_friendLinphoneFriend object to add to the friend list.
Returns
LinphoneFriendListOK if successfully added, LinphoneFriendListInvalidFriend if the friend is not valid.

◆ linphone_friend_list_cbs_get_contact_created()

LinphoneFriendListCbsContactCreatedCb linphone_friend_list_cbs_get_contact_created ( const LinphoneFriendListCbs cbs)

Get the contact created callback.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The current contact created callback.

◆ linphone_friend_list_cbs_get_contact_deleted()

LinphoneFriendListCbsContactDeletedCb linphone_friend_list_cbs_get_contact_deleted ( const LinphoneFriendListCbs cbs)

Get the contact deleted callback.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The current contact deleted callback.

◆ linphone_friend_list_cbs_get_contact_updated()

LinphoneFriendListCbsContactUpdatedCb linphone_friend_list_cbs_get_contact_updated ( const LinphoneFriendListCbs cbs)

Get the contact updated callback.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The current contact updated callback.

◆ linphone_friend_list_cbs_get_presence_received()

LinphoneFriendListCbsPresenceReceivedCb linphone_friend_list_cbs_get_presence_received ( const LinphoneFriendListCbs cbs)

Get the presence received callback.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The current presence received callback.

◆ linphone_friend_list_cbs_get_sync_status_changed()

LinphoneFriendListCbsSyncStateChangedCb linphone_friend_list_cbs_get_sync_status_changed ( const LinphoneFriendListCbs cbs)

Get the sync status changed callback.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The current sync status changedcallback.

◆ linphone_friend_list_cbs_get_user_data()

void* linphone_friend_list_cbs_get_user_data ( const LinphoneFriendListCbs cbs)

Retrieve the user pointer associated with a LinphoneFriendListCbs object.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The user pointer associated with the LinphoneFriendListCbs object.

◆ linphone_friend_list_cbs_ref()

LinphoneFriendListCbs* linphone_friend_list_cbs_ref ( LinphoneFriendListCbs cbs)

Acquire a reference to a LinphoneFriendListCbs object.

Parameters
cbsLinphoneFriendListCbs object.
Returns
The same LinphoneFriendListCbs object.

◆ linphone_friend_list_cbs_set_contact_created()

void linphone_friend_list_cbs_set_contact_created ( LinphoneFriendListCbs cbs,
LinphoneFriendListCbsContactCreatedCb  cb 
)

Set the contact created callback.

Parameters
cbsLinphoneFriendListCbs object.
cbThe contact created to be used.

◆ linphone_friend_list_cbs_set_contact_deleted()

void linphone_friend_list_cbs_set_contact_deleted ( LinphoneFriendListCbs cbs,
LinphoneFriendListCbsContactDeletedCb  cb 
)

Set the contact deleted callback.

Parameters
cbsLinphoneFriendListCbs object.
cbThe contact deleted to be used.

◆ linphone_friend_list_cbs_set_contact_updated()

void linphone_friend_list_cbs_set_contact_updated ( LinphoneFriendListCbs cbs,
LinphoneFriendListCbsContactUpdatedCb  cb 
)

Set the contact updated callback.

Parameters
cbsLinphoneFriendListCbs object.
cbThe contact updated to be used.

◆ linphone_friend_list_cbs_set_presence_received()

void linphone_friend_list_cbs_set_presence_received ( LinphoneFriendListCbs cbs,
LinphoneFriendListCbsPresenceReceivedCb  cb 
)

Set the presence received callback.

Parameters
cbsLinphoneFriendListCbs object.
cbThe presence received callback to be used.

◆ linphone_friend_list_cbs_set_sync_status_changed()

void linphone_friend_list_cbs_set_sync_status_changed ( LinphoneFriendListCbs cbs,
LinphoneFriendListCbsSyncStateChangedCb  cb 
)

Set the contact updated callback.

Parameters
cbsLinphoneFriendListCbs object.
cbThe sync status changed to be used.

◆ linphone_friend_list_cbs_set_user_data()

void linphone_friend_list_cbs_set_user_data ( LinphoneFriendListCbs cbs,
void *  user_data 
)

Assign a user pointer to a LinphoneFriendListCbs object.

Parameters
cbsLinphoneFriendListCbs object.
user_dataThe user pointer to associate with the LinphoneFriendListCbs object.

◆ linphone_friend_list_cbs_unref()

void linphone_friend_list_cbs_unref ( LinphoneFriendListCbs cbs)

Release a reference to a LinphoneFriendListCbs object.

Parameters
cbsLinphoneFriendListCbs object.

◆ linphone_friend_list_enable_subscriptions()

void linphone_friend_list_enable_subscriptions ( LinphoneFriendList friend_list,
bool_t  enabled 
)

Enable subscription to NOTIFYes of all friends list.

Parameters
friend_listthe LinphoneFriendList object
enabledshould subscription be enabled or not

◆ linphone_friend_list_export_friends_as_vcard4_file()

void linphone_friend_list_export_friends_as_vcard4_file ( LinphoneFriendList friend_list,
const char *  vcard_file 
)

Creates and export LinphoneFriend objects from LinphoneFriendList to a file using vCard 4 format.

Parameters
friend_listthe LinphoneFriendList object
vcard_filethe path to a file that will contain the vCards

◆ linphone_friend_list_find_friend_by_address()

LinphoneFriend* linphone_friend_list_find_friend_by_address ( const LinphoneFriendList friend_list,
const LinphoneAddress address 
)

Find a friend in the friend list using a LinphoneAddress.

Parameters
friend_listLinphoneFriendList object.
addressLinphoneAddress object of the friend we want to search for.
Returns
A LinphoneFriend if found, NULL otherwise.

◆ linphone_friend_list_find_friend_by_phone_number()

LinphoneFriend* linphone_friend_list_find_friend_by_phone_number ( const LinphoneFriendList friend_list,
const char *  phone_number 
)

Find a friend in the friend list using a phone number.

Parameters
friend_listLinphoneFriendList object.
phone_numbera string of the phone number for which we want to find a friend.
Returns
A LinphoneFriend if found, NULL otherwise.

◆ linphone_friend_list_find_friend_by_ref_key()

LinphoneFriend* linphone_friend_list_find_friend_by_ref_key ( const LinphoneFriendList friend_list,
const char *  ref_key 
)

Find a friend in the friend list using a ref key.

Parameters
friend_listLinphoneFriendList object.
ref_keyThe ref key string of the friend we want to search for.
Returns
A LinphoneFriend if found, NULL otherwise.

◆ linphone_friend_list_find_friend_by_uri()

LinphoneFriend* linphone_friend_list_find_friend_by_uri ( const LinphoneFriendList friend_list,
const char *  uri 
)

Find a friend in the friend list using an URI string.

Parameters
friend_listLinphoneFriendList object.
uriA string containing the URI of the friend we want to search for.
Returns
A LinphoneFriend if found, NULL otherwise.

◆ linphone_friend_list_find_friends_by_address()

bctbx_list_t* linphone_friend_list_find_friends_by_address ( const LinphoneFriendList friend_list,
const LinphoneAddress address 
)

Find all friends in the friend list using a LinphoneAddress.

Parameters
friend_listLinphoneFriendList object.
addressLinphoneAddress object of the friends we want to search for.
Returns
A list of LinphoneFriend if found, NULL otherwise.

◆ linphone_friend_list_find_friends_by_uri()

bctbx_list_t* linphone_friend_list_find_friends_by_uri ( const LinphoneFriendList friend_list,
const char *  uri 
)

Find all friends in the friend list using an URI string.

Parameters
friend_listLinphoneFriendList object.
uriA string containing the URI of the friends we want to search for.
Returns
A list of LinphoneFriend if found, NULL otherwise.

◆ linphone_friend_list_get_callbacks()

MS2_DEPRECATED LinphoneFriendListCbs* linphone_friend_list_get_callbacks ( const LinphoneFriendList friend_list)

Get the LinphoneFriendListCbs object associated with a LinphoneFriendList.

Parameters
friend_listLinphoneFriendList object
Returns
The LinphoneFriendListCbs object associated with the LinphoneFriendList.
Deprecated:
19/02/2019 use add_callbacks / remove_callbacks instead

◆ linphone_friend_list_get_core()

LinphoneCore* linphone_friend_list_get_core ( const LinphoneFriendList friend_list)

Returns the LinphoneCore object attached to this LinphoneFriendList.

Parameters
friend_listLinphoneFriendList object.
Returns
a LinphoneCore object

◆ linphone_friend_list_get_current_callbacks()

LinphoneFriendListCbs* linphone_friend_list_get_current_callbacks ( const LinphoneFriendList friend_list)

Get the current LinphoneFriendListCbs object associated with a LinphoneFriendList.

Parameters
friend_listLinphoneFriendList object
Returns
The current LinphoneFriendListCbs object associated with the LinphoneFriendList.

◆ linphone_friend_list_get_display_name()

const char* linphone_friend_list_get_display_name ( const LinphoneFriendList friend_list)

Get the display name of the friend list.

Parameters
friend_listLinphoneFriendList object.
Returns
The display name of the friend list.

◆ linphone_friend_list_get_friends()

const bctbx_list_t* linphone_friend_list_get_friends ( const LinphoneFriendList friend_list)

Retrieves the list of LinphoneFriend from this LinphoneFriendList.

Parameters
friend_listLinphoneFriendList object
Returns
A list of LinphoneFriend

◆ linphone_friend_list_get_rls_address()

const LinphoneAddress* linphone_friend_list_get_rls_address ( const LinphoneFriendList friend_list)

Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.

Parameters
friend_listLinphoneFriendList object.
Returns
The RLS URI as LinphoneAddress associated with the friend list.

◆ linphone_friend_list_get_rls_uri()

const char* linphone_friend_list_get_rls_uri ( const LinphoneFriendList friend_list)

Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.

Parameters
friend_listLinphoneFriendList object.
Returns
The RLS URI associated with the friend list.
Deprecated:
27/10/2020. Use linphone_friend_list_get_rls_address() instead.

◆ linphone_friend_list_get_type()

LinphoneFriendListType linphone_friend_list_get_type ( LinphoneFriendList list)

Get the type of a friend list.

Parameters
friend_listLinphoneFriendList object.

◆ linphone_friend_list_get_uri()

const char* linphone_friend_list_get_uri ( const LinphoneFriendList friend_list)

Get the URI associated with the friend list.

Parameters
friend_listLinphoneFriendList object.
Returns
The URI associated with the friend list.

◆ linphone_friend_list_get_user_data()

void* linphone_friend_list_get_user_data ( const LinphoneFriendList friend_list)

Retrieve the user pointer associated with the friend list.

Parameters
friend_listLinphoneFriendList object.
Returns
The user pointer associated with the friend list.

◆ linphone_friend_list_import_friends_from_vcard4_buffer()

int linphone_friend_list_import_friends_from_vcard4_buffer ( LinphoneFriendList friend_list,
const char *  vcard_buffer 
)

Creates and adds LinphoneFriend objects to LinphoneFriendList from a buffer that contains the vCard(s) to parse.

Parameters
friend_listthe LinphoneFriendList object
vcard_bufferthe buffer that contains the vCard(s) to parse
Returns
the amount of linphone friends created

◆ linphone_friend_list_import_friends_from_vcard4_file()

int linphone_friend_list_import_friends_from_vcard4_file ( LinphoneFriendList friend_list,
const char *  vcard_file 
)

Creates and adds LinphoneFriend objects to LinphoneFriendList from a file that contains the vCard(s) to parse.

Parameters
friend_listthe LinphoneFriendList object
vcard_filethe path to a file that contains the vCard(s) to parse
Returns
the amount of linphone friends created

◆ linphone_friend_list_is_subscription_bodyless()

bool_t linphone_friend_list_is_subscription_bodyless ( LinphoneFriendList friend_list)

Get wheter the subscription of the friend list is bodyless or not.

Parameters
friend_listLinphoneFriendList object.
Returns
Wheter the subscription of the friend list is bodyless or not.

◆ linphone_friend_list_notify_presence()

void linphone_friend_list_notify_presence ( LinphoneFriendList friend_list,
LinphonePresenceModel presence 
)

Notify our presence to all the friends in the friend list that have subscribed to our presence directly (not using a RLS).

Parameters
friend_listLinphoneFriendList object.
presenceLinphonePresenceModel object.

◆ linphone_friend_list_ref()

LinphoneFriendList* linphone_friend_list_ref ( LinphoneFriendList friend_list)

Acquire a reference to the friend list.

Parameters
friend_listLinphoneFriendList object.
Returns
The same LinphoneFriendList object.

◆ linphone_friend_list_remove_callbacks()

void linphone_friend_list_remove_callbacks ( LinphoneFriendList friend_list,
LinphoneFriendListCbs cbs 
)

Removes the LinphoneFriendListCbs object associated with a LinphoneFriendList.

Parameters
friend_listLinphoneFriendList object
cbsThe current LinphoneFriendListCbs object to be remove from the LinphoneFriendList.

◆ linphone_friend_list_remove_friend()

LinphoneFriendListStatus linphone_friend_list_remove_friend ( LinphoneFriendList friend_list,
LinphoneFriend linphone_friend 
)

Remove a friend from a friend list.

Parameters
friend_listLinphoneFriendList object.
linphone_friendLinphoneFriend object to remove from the friend list.
Returns
LinphoneFriendListOK if removed successfully, LinphoneFriendListNonExistentFriend if the friend is not in the list.

◆ linphone_friend_list_set_display_name()

void linphone_friend_list_set_display_name ( LinphoneFriendList friend_list,
const char *  display_name 
)

Set the display name of the friend list.

Parameters
friend_listLinphoneFriendList object.
display_nameThe new display name of the friend list.

◆ linphone_friend_list_set_rls_address()

void linphone_friend_list_set_rls_address ( LinphoneFriendList friend_list,
const LinphoneAddress rls_addr 
)

Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.

Parameters
friend_listLinphoneFriendList object.
rls_addrThe RLS URI to associate with the friend list.

◆ linphone_friend_list_set_rls_uri()

void linphone_friend_list_set_rls_uri ( LinphoneFriendList friend_list,
const char *  rls_uri 
)

Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.

Parameters
friend_listLinphoneFriendList object.
rls_uriThe RLS URI to associate with the friend list.
Deprecated:
27/10/2020. Use linphone_friend_list_set_rls_address() instead.

◆ linphone_friend_list_set_subscription_bodyless()

void linphone_friend_list_set_subscription_bodyless ( LinphoneFriendList friend_list,
bool_t  bodyless 
)

Set wheter the subscription of the friend list is bodyless or not.

Parameters
friend_listLinphoneFriendList object.
bodylessboolean telling if the subscription of the friend list is bodyless or not.

◆ linphone_friend_list_set_type()

void linphone_friend_list_set_type ( LinphoneFriendList friend_list,
LinphoneFriendListType  type 
)

Assign a friend list type to the friend list.

Parameters
friend_listLinphoneFriendList object.
typeLinphoneFriendListType to assing

◆ linphone_friend_list_set_uri()

void linphone_friend_list_set_uri ( LinphoneFriendList friend_list,
const char *  uri 
)

Set the URI associated with the friend list.

Parameters
friend_listLinphoneFriendList object.
uriThe URI to associate with the friend list.

◆ linphone_friend_list_set_user_data()

void linphone_friend_list_set_user_data ( LinphoneFriendList friend_list,
void *  user_data 
)

Assign a user pointer to the friend list.

Parameters
friend_listLinphoneFriendList object.
user_dataThe user pointer to associate with the friend list.

◆ linphone_friend_list_subscriptions_enabled()

bool_t linphone_friend_list_subscriptions_enabled ( LinphoneFriendList friend_list)

Gets whether subscription to NOTIFYes of all friends list are enabled or not.

Parameters
friend_listthe LinphoneFriendList object
Returns
Whether subscriptions are enabled or not

◆ linphone_friend_list_synchronize_friends_from_server()

void linphone_friend_list_synchronize_friends_from_server ( LinphoneFriendList friend_list)

Starts a CardDAV synchronization using value set using linphone_friend_list_set_uri.

Parameters
friend_listLinphoneFriendList object.

◆ linphone_friend_list_unref()

void linphone_friend_list_unref ( LinphoneFriendList friend_list)

Release reference to the friend list.

Parameters
friend_listLinphoneFriendList object.

◆ linphone_friend_list_update_dirty_friends()

void linphone_friend_list_update_dirty_friends ( LinphoneFriendList friend_list)

Goes through all the LinphoneFriend that are dirty and does a CardDAV PUT to update the server.

Parameters
friend_listLinphoneFriendList object.

◆ linphone_friend_list_update_revision()

void linphone_friend_list_update_revision ( LinphoneFriendList friend_list,
int  revision 
)

Sets the revision from the last synchronization.

Parameters
friend_listLinphoneFriendList object.
revisionThe revision

◆ linphone_friend_list_update_subscriptions()

void linphone_friend_list_update_subscriptions ( LinphoneFriendList friend_list)

Update presence subscriptions for the entire list.

Calling this function is necessary when list subscriptions are enabled, ie when a RLS presence server is used.

Parameters
friend_listthe LinphoneFriendList

◆ linphone_friend_new()

MS2_DEPRECATED LinphoneFriend* linphone_friend_new ( void  )

Contructor.

Returns
a new empty LinphoneFriend
Deprecated:
03/02/2016 use linphone_core_create_friend() instead

◆ linphone_friend_new_from_vcard()

LinphoneFriend* linphone_friend_new_from_vcard ( LinphoneVcard vcard)

Contructor same as linphone_friend_new() + linphone_friend_set_address()

Parameters
vcarda LinphoneVcard object
Returns
a new LinphoneFriend which has its vCard attribute initialized from the given vCard. This can be get by linphone_friend_get_vcard().

◆ linphone_friend_new_with_address()

MS2_DEPRECATED LinphoneFriend* linphone_friend_new_with_address ( const char *  addr)

Contructor same as linphone_friend_new() + linphone_friend_set_address()

Parameters
addra buddy address, must be a sip uri like sip:joe@s.nosp@m.ip.l.nosp@m.inpho.nosp@m.ne.o.nosp@m.rg
Returns
a new LinphoneFriend with an initialized address.
Deprecated:
03/02/2016 use linphone_core_create_friend_with_address() instead

◆ linphone_friend_phone_number_clone()

LinphoneFriendPhoneNumber* linphone_friend_phone_number_clone ( const LinphoneFriendPhoneNumber phone_number)

Clones a phone number.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object to be cloned.
Returns
The newly created LinphoneFriendPhoneNumber object.

◆ linphone_friend_phone_number_get_label()

const char* linphone_friend_phone_number_get_label ( const LinphoneFriendPhoneNumber phone_number)

Gets the label associated to this phone number.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object.
Returns
the label set if any, NULL otherwise.

◆ linphone_friend_phone_number_get_phone_number()

const char* linphone_friend_phone_number_get_phone_number ( const LinphoneFriendPhoneNumber phone_number)

Gets the phone number.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object.
Returns
the phone number stored.

◆ linphone_friend_phone_number_new()

LinphoneFriendPhoneNumber* linphone_friend_phone_number_new ( const char *  phone_number,
const char *  label 
)

Creates a new LinphoneFriendPhoneNumber.

Parameters
phone_numberThe phone number.
labelthe type of phone number, for example "home", "cell", etc. Use NULL or empty for no label.
Returns
The newly created LinphoneFriendPhoneNumber object.

◆ linphone_friend_phone_number_ref()

LinphoneFriendPhoneNumber* linphone_friend_phone_number_ref ( LinphoneFriendPhoneNumber phone_number)

Takes a reference on a LinphoneFriendPhoneNumber.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object.
Returns
the same LinphoneFriendPhoneNumber object.

◆ linphone_friend_phone_number_set_label()

void linphone_friend_phone_number_set_label ( LinphoneFriendPhoneNumber phone_number,
const char *  label 
)

Sets the label for this phone number.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object.
labelthe label to set.

◆ linphone_friend_phone_number_set_phone_number()

void linphone_friend_phone_number_set_phone_number ( LinphoneFriendPhoneNumber phone_number,
const char *  number 
)

Sets the phone number.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object.
numberthe phone number to set.

◆ linphone_friend_phone_number_unref()

void linphone_friend_phone_number_unref ( LinphoneFriendPhoneNumber phone_number)

Releases a LinphoneFriendPhoneNumber.

Parameters
phone_numberThe LinphoneFriendPhoneNumber object.

◆ linphone_friend_ref()

LinphoneFriend* linphone_friend_ref ( LinphoneFriend linphone_friend)

Acquire a reference to the linphone friend.

Parameters
linphone_friendLinphoneFriend object
Returns
The same LinphoneFriend object

◆ linphone_friend_remove()

void linphone_friend_remove ( LinphoneFriend linphone_friend)

Removes a friend from it's friend list and from the rc if exists.

Parameters
linphone_friendLinphoneFriend object to delete

◆ linphone_friend_remove_address()

void linphone_friend_remove_address ( LinphoneFriend linphone_friend,
const LinphoneAddress address 
)

Removes an address in this friend.

Parameters
linphone_friendLinphoneFriend object
addressLinphoneAddress object

◆ linphone_friend_remove_phone_number()

void linphone_friend_remove_phone_number ( LinphoneFriend linphone_friend,
const char *  phone_number 
)

Removes a phone number in this friend.

Parameters
linphone_friendLinphoneFriend object
phone_numbernumber to remove

◆ linphone_friend_remove_phone_number_with_label()

void linphone_friend_remove_phone_number_with_label ( LinphoneFriend linphone_friend,
const LinphoneFriendPhoneNumber phone_number 
)

Removes a LinphoneFriendPhoneNumber from this friend.

Parameters
linphone_friendLinphoneFriend object
phone_numberthe LinphoneFriendPhoneNumber to remove

◆ linphone_friend_save()

void linphone_friend_save ( LinphoneFriend linphone_friend,
LinphoneCore core 
)

Saves a friend either in database if configured, otherwise in linphonerc.

Parameters
linphone_friendthe linphone friend to save
corethe linphone core

◆ linphone_friend_set_address()

LinphoneStatus linphone_friend_set_address ( LinphoneFriend fr,
const LinphoneAddress address 
)

Set LinphoneAddress for this friend.

Parameters
linphone_friendLinphoneFriend object
addressthe LinphoneAddress to set return 0 if successfull, -1 otherwise

◆ linphone_friend_set_inc_subscribe_policy()

LinphoneStatus linphone_friend_set_inc_subscribe_policy ( LinphoneFriend fr,
LinphoneSubscribePolicy  policy 
)

Configure incoming subscription policy for this friend.

Parameters
linphone_friendLinphoneFriend object
policyLinphoneSubscribePolicy policy to apply.
Returns
0

◆ linphone_friend_set_name()

LinphoneStatus linphone_friend_set_name ( LinphoneFriend linphone_friend,
const char *  name 
)

Set the display name for this friend.

Parameters
linphone_friendLinphoneFriend object
namethe display name to set
Returns
0 if successful, -1 otherwise

◆ linphone_friend_set_native_uri()

void linphone_friend_set_native_uri ( LinphoneFriend linphone_friend,
const char *  native_uri 
)

Sets the contact's native URI.

Parameters
linphone_friendthe LinphoneFriend object.
native_urithe URI that matches the contact on the native system.

◆ linphone_friend_set_organization()

void linphone_friend_set_organization ( LinphoneFriend linphone_friend,
const char *  organization 
)

Sets the contact's organization.

It's a shortcut to linphone_friend_get_vcard() and linphone_vcard_set_organization().

Parameters
linphone_friendthe LinphoneFriend object.
organizationthe organization to store in Friend's vCard.

◆ linphone_friend_set_photo()

void linphone_friend_set_photo ( LinphoneFriend linphone_friend,
const char *  picture_uri 
)

Sets the contact's picture URI.

Parameters
linphone_friendthe LinphoneFriend object.
picture_urithe picture URI to set.

◆ linphone_friend_set_presence_model()

void linphone_friend_set_presence_model ( LinphoneFriend linphone_friend,
LinphonePresenceModel presence 
)

Set the presence model of a friend.

Parameters
linphone_friendA LinphoneFriend object
presenceThe LinphonePresenceModel object to set for the friend

◆ linphone_friend_set_presence_model_for_uri_or_tel()

void linphone_friend_set_presence_model_for_uri_or_tel ( LinphoneFriend linphone_friend,
const char *  uri_or_tel,
LinphonePresenceModel presence 
)

Set the presence model for a specific SIP URI or phone number of a friend.

Parameters
linphone_friendA LinphoneFriend object
uri_or_telThe SIP URI or phone number for which to set the presence model
presenceThe LinphonePresenceModel object to set

◆ linphone_friend_set_ref_key()

void linphone_friend_set_ref_key ( LinphoneFriend linphone_friend,
const char *  key 
)

Set the reference key of a friend.

Parameters
linphone_friendLinphoneFriend object.
keyThe reference key to use for the friend.

◆ linphone_friend_set_starred()

void linphone_friend_set_starred ( LinphoneFriend linphone_friend,
bool_t  is_starred 
)

Sets if the friend is a user's favorite or important contact.

Parameters
linphone_friendthe LinphoneFriend object.
is_starredTRUE if the friend is to be considered as important, FALSE otherwise.

◆ linphone_friend_set_user_data()

void linphone_friend_set_user_data ( LinphoneFriend linphone_friend,
void *  user_data 
)

Store user pointer to friend object.

Parameters
linphone_friendA LinphoneFriend object
user_datathe user data to store.

◆ linphone_friend_set_vcard()

void linphone_friend_set_vcard ( LinphoneFriend linphone_friend,
LinphoneVcard vcard 
)

Binds a vCard object to a friend.

Parameters
linphone_friendLinphoneFriend object
vcardThe LinphoneVcard object to bind

◆ linphone_friend_subscribes_enabled()

bool_t linphone_friend_subscribes_enabled ( const LinphoneFriend linphone_friend)

get subscription flag value

Parameters
linphone_friendLinphoneFriend object
Returns
returns TRUE is subscription is activated for this friend

◆ linphone_friend_unref()

void linphone_friend_unref ( LinphoneFriend linphone_friend)

Release a reference to the linphone friend.

Parameters
linphone_friendLinphoneFriend object

◆ linphone_presence_activity_get_description()

const char* linphone_presence_activity_get_description ( const LinphonePresenceActivity activity)

Gets the description of a presence activity.

Parameters
activityA pointer to the LinphonePresenceActivity for which to get the description.
Returns
A pointer to the description string of the presence activity, or NULL if no description is specified.

◆ linphone_presence_activity_get_type()

LinphonePresenceActivityType linphone_presence_activity_get_type ( const LinphonePresenceActivity activity)

Gets the activity type of a presence activity.

Parameters
activityA pointer to the LinphonePresenceActivity for which to get the type.
Returns
The LinphonePresenceActivityType of the activity.

◆ linphone_presence_activity_get_user_data()

void* linphone_presence_activity_get_user_data ( const LinphonePresenceActivity activity)

Gets the user data of a LinphonePresenceActivity object.

Parameters
activityThe LinphonePresenceActivity object for which to get the user data.
Returns
A pointer to the user data.

◆ linphone_presence_activity_new()

LinphonePresenceActivity* linphone_presence_activity_new ( LinphonePresenceActivityType  acttype,
const char *  description 
)

Creates a presence activity.

Parameters
acttypeThe LinphonePresenceActivityType to set for the activity.
descriptionAn additional description of the activity to set for the activity. Can be NULL if no additional description is to be added.
Returns
The created presence activity, NULL on error.

◆ linphone_presence_activity_ref()

LinphonePresenceActivity* linphone_presence_activity_ref ( LinphonePresenceActivity activity)

Increase the reference count of the LinphonePresenceActivity object.

Parameters
activityThe LinphonePresenceActivity object for which the reference count is to be increased.
Returns
The LinphonePresenceActivity object with the increased reference count.

◆ linphone_presence_activity_set_description()

LinphoneStatus linphone_presence_activity_set_description ( LinphonePresenceActivity activity,
const char *  description 
)

Sets the description of a presence activity.

Parameters
activityThe LinphonePresenceActivity object for which to set the description.
descriptionAn additional description of the activity. Can be NULL if no additional description is to be added.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_activity_set_type()

LinphoneStatus linphone_presence_activity_set_type ( LinphonePresenceActivity activity,
LinphonePresenceActivityType  acttype 
)

Sets the type of activity of a presence activity.

Parameters
activityThe LinphonePresenceActivity for which to set for the activity type.
acttypeThe LinphonePresenceActivityType to set for the activity.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_activity_set_user_data()

void linphone_presence_activity_set_user_data ( LinphonePresenceActivity activity,
void *  user_data 
)

Sets the user data of a LinphonePresenceActivity object.

Parameters
activityThe LinphonePresenceActivity object for which to set the user data.
user_dataA pointer to the user data to set.

◆ linphone_presence_activity_to_string()

char* linphone_presence_activity_to_string ( const LinphonePresenceActivity activity)

Gets the string representation of a presence activity.

Parameters
activityA pointer to the LinphonePresenceActivity object for which to get a string representation.
Returns
A pointer a dynamically allocated string representing the given activity.

The returned string is to be freed by calling ms_free().

◆ linphone_presence_activity_unref()

LinphonePresenceActivity* linphone_presence_activity_unref ( LinphonePresenceActivity activity)

Decrease the reference count of the LinphonePresenceActivity object and destroy it if it reaches 0.

Parameters
activityThe LinphonePresenceActivity object for which the reference count is to be decreased.
Returns
The LinphonePresenceActivity object if the reference count is still positive, NULL if the object has been destroyed.

◆ linphone_presence_basic_status_to_string()

char* linphone_presence_basic_status_to_string ( LinphonePresenceBasicStatus  basic_status)

Gets the string representation of a presence basic status.

Parameters
basic_statusA LinphonePresenceBasicStatus for which to get a string representation.
Returns
A pointer a dynamically allocated string representing the given basic status.

The returned string is to be freed by calling ms_free().

◆ linphone_presence_model_add_activity()

LinphoneStatus linphone_presence_model_add_activity ( LinphonePresenceModel model,
LinphonePresenceActivity activity 
)

Adds an activity to a presence model.

Parameters
modelThe LinphonePresenceModel object for which to add an activity.
activityThe LinphonePresenceActivity object to add to the model.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_add_note()

LinphoneStatus linphone_presence_model_add_note ( LinphonePresenceModel model,
const char *  note_content,
const char *  lang 
)

Adds a note to a presence model.

Parameters
modelThe LinphonePresenceModel object to add a note to.
note_contentThe note to be added to the presence model.
langThe language of the note to be added. Can be NULL if no language is to be specified for the note.
Returns
0 if successful, a value < 0 in case of error.

Only one note for each language can be set, so e.g. setting a note for the 'fr' language if there is only one will replace the existing one.

◆ linphone_presence_model_add_person()

LinphoneStatus linphone_presence_model_add_person ( LinphonePresenceModel model,
LinphonePresencePerson person 
)

Adds a person to a presence model.

Parameters
modelThe LinphonePresenceModel object for which to add a person.
personThe LinphonePresencePerson object to add to the model.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_add_service()

LinphoneStatus linphone_presence_model_add_service ( LinphonePresenceModel model,
LinphonePresenceService service 
)

Adds a service to a presence model.

Parameters
modelThe LinphonePresenceModel object for which to add a service.
serviceThe LinphonePresenceService object to add to the model.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_clear_activities()

LinphoneStatus linphone_presence_model_clear_activities ( LinphonePresenceModel model)

Clears the activities of a presence model.

Parameters
modelThe LinphonePresenceModel object for which to clear the activities.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_clear_notes()

LinphoneStatus linphone_presence_model_clear_notes ( LinphonePresenceModel model)

Clears all the notes of a presence model.

Parameters
modelThe LinphonePresenceModel for which to clear notes.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_clear_persons()

LinphoneStatus linphone_presence_model_clear_persons ( LinphonePresenceModel model)

Clears the persons of a presence model.

Parameters
modelThe LinphonePresenceModel object for which to clear the persons.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_clear_services()

LinphoneStatus linphone_presence_model_clear_services ( LinphonePresenceModel model)

Clears the services of a presence model.

Parameters
modelThe LinphonePresenceModel object for which to clear the services.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_get_activity()

LinphonePresenceActivity* linphone_presence_model_get_activity ( const LinphonePresenceModel model)

Gets the first activity of a presence model (there is usually only one).

Parameters
modelThe LinphonePresenceModel object to get the activity from.
Returns
A LinphonePresenceActivity object if successful, NULL otherwise.

◆ linphone_presence_model_get_basic_status()

LinphonePresenceBasicStatus linphone_presence_model_get_basic_status ( const LinphonePresenceModel model)

Gets the basic status of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the basic status from.
Returns
The LinphonePresenceBasicStatus of the LinphonePresenceModel object given as parameter.

◆ linphone_presence_model_get_capabilities()

int linphone_presence_model_get_capabilities ( const LinphonePresenceModel model)

Gets the capabilities of a LinphonePresenceModel object.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
Returns
the capabilities.

◆ linphone_presence_model_get_capability_version()

float linphone_presence_model_get_capability_version ( const LinphonePresenceModel model,
const LinphoneFriendCapability  capability 
)

Returns the version of the capability of a LinphonePresenceModel.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
capabilityThe LinphoneFriendCapability to test.
Returns
the version of the capability of a LinphonePresenceModel or -1.0 if the model has not the capability.

◆ linphone_presence_model_get_consolidated_presence()

LinphoneConsolidatedPresence linphone_presence_model_get_consolidated_presence ( const LinphonePresenceModel model)

Get the consolidated presence from a presence model.

Parameters
modelLinphonePresenceModel object
Returns
The LinphoneConsolidatedPresence corresponding to the presence model

◆ linphone_presence_model_get_contact()

char* linphone_presence_model_get_contact ( const LinphonePresenceModel model)

Gets the contact of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the contact from.
Returns
A pointer to a dynamically allocated string containing the contact, or NULL if no contact is found.

The returned string is to be freed by calling ms_free().

◆ linphone_presence_model_get_nb_activities()

unsigned int linphone_presence_model_get_nb_activities ( const LinphonePresenceModel model)

Gets the number of activities included in the presence model.

Parameters
modelThe LinphonePresenceModel object to get the number of activities from.
Returns
The number of activities included in the LinphonePresenceModel object.

◆ linphone_presence_model_get_nb_persons()

unsigned int linphone_presence_model_get_nb_persons ( const LinphonePresenceModel model)

Gets the number of persons included in the presence model.

Parameters
modelThe LinphonePresenceModel object to get the number of persons from.
Returns
The number of persons included in the LinphonePresenceModel object.

◆ linphone_presence_model_get_nb_services()

unsigned int linphone_presence_model_get_nb_services ( const LinphonePresenceModel model)

Gets the number of services included in the presence model.

Parameters
modelThe LinphonePresenceModel object to get the number of services from.
Returns
The number of services included in the LinphonePresenceModel object.

◆ linphone_presence_model_get_note()

LinphonePresenceNote* linphone_presence_model_get_note ( const LinphonePresenceModel model,
const char *  lang 
)

Gets the first note of a presence model (there is usually only one).

Parameters
modelThe LinphonePresenceModel object to get the note from.
langThe language of the note to get. Can be NULL to get a note that has no language specified or to get the first note whatever language it is written into.
Returns
A pointer to a LinphonePresenceNote object if successful, NULL otherwise.

◆ linphone_presence_model_get_nth_activity()

LinphonePresenceActivity* linphone_presence_model_get_nth_activity ( const LinphonePresenceModel model,
unsigned int  index 
)

Gets the nth activity of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the activity from.
indexThe index of the activity to get (the first activity having the index 0).
Returns
A pointer to a LinphonePresenceActivity object if successful, NULL otherwise.

◆ linphone_presence_model_get_nth_person()

LinphonePresencePerson* linphone_presence_model_get_nth_person ( const LinphonePresenceModel model,
unsigned int  index 
)

Gets the nth person of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the person from.
indexThe index of the person to get (the first person having the index 0).
Returns
A pointer to a LinphonePresencePerson object if successful, NULL otherwise.

◆ linphone_presence_model_get_nth_service()

LinphonePresenceService* linphone_presence_model_get_nth_service ( const LinphonePresenceModel model,
unsigned int  index 
)

Gets the nth service of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the service from.
indexThe index of the service to get (the first service having the index 0).
Returns
A pointer to a LinphonePresenceService object if successful, NULL otherwise.

◆ linphone_presence_model_get_presentity()

const LinphoneAddress* linphone_presence_model_get_presentity ( const LinphonePresenceModel model)

Gets the presentity of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the contact from.
Returns
A pointer to a const LinphoneAddress, or NULL if no contact is found.

◆ linphone_presence_model_get_timestamp()

time_t linphone_presence_model_get_timestamp ( const LinphonePresenceModel model)

Gets the timestamp of a presence model.

Parameters
modelThe LinphonePresenceModel object to get the timestamp from.
Returns
The timestamp of the LinphonePresenceModel object or -1 on error.

◆ linphone_presence_model_get_user_data()

void* linphone_presence_model_get_user_data ( const LinphonePresenceModel model)

Gets the user data of a LinphonePresenceModel object.

Parameters
modelThe LinphonePresenceModel object for which to get the user data.
Returns
A pointer to the user data.

◆ linphone_presence_model_has_capability()

bool_t linphone_presence_model_has_capability ( const LinphonePresenceModel model,
const LinphoneFriendCapability  capability 
)

Returns whether or not the LinphonePresenceModel object has a given capability.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
capabilityThe capability to test.
Returns
whether or not the LinphonePresenceModel object has a given capability.

◆ linphone_presence_model_has_capability_with_version()

bool_t linphone_presence_model_has_capability_with_version ( const LinphonePresenceModel model,
const LinphoneFriendCapability  capability,
float  version 
)

Returns whether or not the LinphonePresenceModel object has a given capability with a certain version.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
capabilityThe LinphoneFriendCapability to test.
versionThe wanted version to test.
Returns
whether or not the LinphonePresenceModel object has a given capability with a certain version.

◆ linphone_presence_model_has_capability_with_version_or_more()

bool_t linphone_presence_model_has_capability_with_version_or_more ( const LinphonePresenceModel model,
const LinphoneFriendCapability  capability,
float  version 
)

Returns whether or not the LinphonePresenceModel object has a given capability with a certain version or more.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
capabilityThe LinphoneFriendCapability to test.
versionThe wanted version to test.
Returns
whether or not the LinphonePresenceModel object has a given capability with a certain version or more.

◆ linphone_presence_model_is_online()

bool_t linphone_presence_model_is_online ( const LinphonePresenceModel model)

Tells whether a presence model is considered online.

It is any of theses cases:

  • basic status is'open' and no activities
  • explicit 'online' tag in the status
    Parameters
    modelLinphonePresenceModel object
    Returns
    A boolean value telling whether the presence model is considered online or not.

◆ linphone_presence_model_new()

LinphonePresenceModel* linphone_presence_model_new ( void  )

Creates a default presence model.

Returns
The created presence model, NULL on error.
See also
linphone_presence_model_new_with_activity(), linphone_presence_model_new_with_activity_and_note()

The created presence model is considered 'offline'.

◆ linphone_presence_model_new_with_activity()

LinphonePresenceModel* linphone_presence_model_new_with_activity ( LinphonePresenceActivityType  activity,
const char *  description 
)

Creates a presence model specifying an activity.

Parameters
activityThe LinphonePresenceActivityType to set for the created presence model.
descriptionAn additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description.
Returns
The created LinphonePresenceModel, or NULL if an error occured.
See also
linphone_presence_model_new(), linphone_presence_model_new_with_activity_and_note()

The created presence model has the activity specified in the parameters.

◆ linphone_presence_model_new_with_activity_and_note()

LinphonePresenceModel* linphone_presence_model_new_with_activity_and_note ( LinphonePresenceActivityType  activity,
const char *  description,
const char *  note,
const char *  lang 
)

Creates a presence model specifying an activity and adding a note.

Parameters
activityThe LinphonePresenceActivityType to set for the created presence model.
descriptionAn additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description.
noteAn additional note giving additional information about the contact presence.
langThe language the note is written in. It can be set to NULL in order to not specify the language of the note.
Returns
The created LinphonePresenceModel, or NULL if an error occured.
See also
linphone_presence_model_new_with_activity(), linphone_presence_model_new_with_activity_and_note()

The created presence model has the activity and the note specified in the parameters.

◆ linphone_presence_model_ref()

LinphonePresenceModel* linphone_presence_model_ref ( LinphonePresenceModel model)

Increase the reference count of the LinphonePresenceModel object.

Parameters
modelThe LinphonePresenceModel object for which the reference count is to be increased.
Returns
The LinphonePresenceModel object with the increased reference count.

◆ linphone_presence_model_set_activity()

LinphoneStatus linphone_presence_model_set_activity ( LinphonePresenceModel model,
LinphonePresenceActivityType  activity,
const char *  description 
)

Sets the activity of a presence model (limits to only one activity).

Parameters
modelThe LinphonePresenceModel object for which to set the activity.
activityThe LinphonePresenceActivityType to set for the model.
descriptionAn additional description of the activity to set for the model. Can be NULL if no additional description is to be added.
Returns
0 if successful, a value < 0 in case of error.

WARNING: This function will modify the basic status of the model according to the activity being set. If you don't want the basic status to be modified automatically, you can use the combination of linphone_presence_model_set_basic_status(), linphone_presence_model_clear_activities() and linphone_presence_model_add_activity().

◆ linphone_presence_model_set_basic_status()

LinphoneStatus linphone_presence_model_set_basic_status ( LinphonePresenceModel model,
LinphonePresenceBasicStatus  basic_status 
)

Sets the basic status of a presence model.

Parameters
modelThe LinphonePresenceModel object for which to set the basic status.
basic_statusThe LinphonePresenceBasicStatus to set for the LinphonePresenceModel object.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_set_contact()

LinphoneStatus linphone_presence_model_set_contact ( LinphonePresenceModel model,
const char *  contact 
)

Sets the contact of a presence model.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
contactThe contact string to set.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_set_presentity()

LinphoneStatus linphone_presence_model_set_presentity ( LinphonePresenceModel model,
const LinphoneAddress presentity 
)

Sets the presentity of a presence model.

Parameters
modelThe LinphonePresenceModel object for which to set the contact.
presentityThe presentity address to set (presentity is copied).
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_model_set_user_data()

void linphone_presence_model_set_user_data ( LinphonePresenceModel model,
void *  user_data 
)

Sets the user data of a LinphonePresenceModel object.

Parameters
modelThe LinphonePresenceModel object for which to set the user data.
user_dataA pointer to the user data to set.

◆ linphone_presence_model_unref()

LinphonePresenceModel* linphone_presence_model_unref ( LinphonePresenceModel model)

Decrease the reference count of the LinphonePresenceModel object and destroy it if it reaches 0.

Parameters
modelThe LinphonePresenceModel object for which the reference count is to be decreased.
Returns
The LinphonePresenceModel object if the reference count is still positive, NULL if the object has been destroyed.

◆ linphone_presence_note_get_content()

const char* linphone_presence_note_get_content ( const LinphonePresenceNote note)

Gets the content of a presence note.

Parameters
noteA pointer to the LinphonePresenceNote for which to get the content.
Returns
A pointer to the content of the presence note.

◆ linphone_presence_note_get_lang()

const char* linphone_presence_note_get_lang ( const LinphonePresenceNote note)

Gets the language of a presence note.

Parameters
noteA pointer to the LinphonePresenceNote for which to get the language.
Returns
A pointer to the language string of the presence note, or NULL if no language is specified.

◆ linphone_presence_note_get_user_data()

void* linphone_presence_note_get_user_data ( const LinphonePresenceNote note)

Gets the user data of a LinphonePresenceNote object.

Parameters
noteThe LinphonePresenceNote object for which to get the user data.
Returns
A pointer to the user data.

◆ linphone_presence_note_new()

LinphonePresenceNote* linphone_presence_note_new ( const char *  content,
const char *  lang 
)

Creates a presence note.

Parameters
contentThe content of the note to be created.
langThe language of the note to be created. Can be NULL if no language is to be specified for the note.
Returns
The created presence note, NULL on error.

◆ linphone_presence_note_ref()

LinphonePresenceNote* linphone_presence_note_ref ( LinphonePresenceNote note)

Increase the reference count of the LinphonePresenceNote object.

Parameters
noteThe LinphonePresenceNote object for which the reference count is to be increased.
Returns
The LinphonePresenceNote object with the increased reference count.

◆ linphone_presence_note_set_content()

LinphoneStatus linphone_presence_note_set_content ( LinphonePresenceNote note,
const char *  content 
)

Sets the content of a presence note.

Parameters
noteThe LinphonePresenceNote object for which to set the content.
contentThe content of the note.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_note_set_lang()

LinphoneStatus linphone_presence_note_set_lang ( LinphonePresenceNote note,
const char *  lang 
)

Sets the language of a presence note.

Parameters
noteThe LinphonePresenceNote object for which to set the language.
langThe language of the note.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_note_set_user_data()

void linphone_presence_note_set_user_data ( LinphonePresenceNote note,
void *  user_data 
)

Sets the user data of a LinphonePresenceNote object.

Parameters
noteThe LinphonePresenceNote object for which to set the user data.
user_dataA pointer to the user data to set.

◆ linphone_presence_note_unref()

LinphonePresenceNote* linphone_presence_note_unref ( LinphonePresenceNote note)

Decrease the reference count of the LinphonePresenceNote object and destroy it if it reaches 0.

Parameters
noteThe LinphonePresenceNote object for which the reference count is to be decreased.
Returns
The LinphonePresenceNote object if the reference count is still positive, NULL if the object has been destroyed.

◆ linphone_presence_person_add_activities_note()

LinphoneStatus linphone_presence_person_add_activities_note ( LinphonePresencePerson person,
LinphonePresenceNote note 
)

Adds an activities note to a presence person.

Parameters
personThe LinphonePresencePerson object for which to add an activities note.
noteThe LinphonePresenceNote object to add to the person.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_add_activity()

LinphoneStatus linphone_presence_person_add_activity ( LinphonePresencePerson person,
LinphonePresenceActivity activity 
)

Adds an activity to a presence person.

Parameters
personThe LinphonePresencePerson object for which to add an activity.
activityThe LinphonePresenceActivity object to add to the person.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_add_note()

LinphoneStatus linphone_presence_person_add_note ( LinphonePresencePerson person,
LinphonePresenceNote note 
)

Adds a note to a presence person.

Parameters
personThe LinphonePresencePerson object for which to add a note.
noteThe LinphonePresenceNote object to add to the person.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_clear_activities()

LinphoneStatus linphone_presence_person_clear_activities ( LinphonePresencePerson person)

Clears the activities of a presence person.

Parameters
personThe LinphonePresencePerson object for which to clear the activities.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_clear_activities_notes()

LinphoneStatus linphone_presence_person_clear_activities_notes ( LinphonePresencePerson person)

Clears the activities notes of a presence person.

Parameters
personThe LinphonePresencePerson object for which to clear the activities notes.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_clear_notes()

LinphoneStatus linphone_presence_person_clear_notes ( LinphonePresencePerson person)

Clears the notes of a presence person.

Parameters
personThe LinphonePresencePerson object for which to clear the notes.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_get_id()

char* linphone_presence_person_get_id ( const LinphonePresencePerson person)

Gets the id of a presence person.

Parameters
personThe LinphonePresencePerson object to get the id from.
Returns
A pointer to a dynamically allocated string containing the id, or NULL in case of error.

The returned string is to be freed by calling ms_free().

◆ linphone_presence_person_get_nb_activities()

unsigned int linphone_presence_person_get_nb_activities ( const LinphonePresencePerson person)

Gets the number of activities included in the presence person.

Parameters
personThe LinphonePresencePerson object to get the number of activities from.
Returns
The number of activities included in the LinphonePresencePerson object.

◆ linphone_presence_person_get_nb_activities_notes()

unsigned int linphone_presence_person_get_nb_activities_notes ( const LinphonePresencePerson person)

Gets the number of activities notes included in the presence person.

Parameters
personThe LinphonePresencePerson object to get the number of activities notes from.
Returns
The number of activities notes included in the LinphonePresencePerson object.

◆ linphone_presence_person_get_nb_notes()

unsigned int linphone_presence_person_get_nb_notes ( const LinphonePresencePerson person)

Gets the number of notes included in the presence person.

Parameters
personThe LinphonePresencePerson object to get the number of notes from.
Returns
The number of notes included in the LinphonePresencePerson object.

◆ linphone_presence_person_get_nth_activities_note()

LinphonePresenceNote* linphone_presence_person_get_nth_activities_note ( const LinphonePresencePerson person,
unsigned int  index 
)

Gets the nth activities note of a presence person.

Parameters
personThe LinphonePresencePerson object to get the activities note from.
indexThe index of the activities note to get (the first note having the index 0).
Returns
A pointer to a LinphonePresenceNote object if successful, NULL otherwise.

◆ linphone_presence_person_get_nth_activity()

LinphonePresenceActivity* linphone_presence_person_get_nth_activity ( const LinphonePresencePerson person,
unsigned int  index 
)

Gets the nth activity of a presence person.

Parameters
personThe LinphonePresencePerson object to get the activity from.
indexThe index of the activity to get (the first activity having the index 0).
Returns
A pointer to a LinphonePresenceActivity object if successful, NULL otherwise.

◆ linphone_presence_person_get_nth_note()

LinphonePresenceNote* linphone_presence_person_get_nth_note ( const LinphonePresencePerson person,
unsigned int  index 
)

Gets the nth note of a presence person.

Parameters
personThe LinphonePresencePerson object to get the note from.
indexThe index of the note to get (the first note having the index 0).
Returns
A pointer to a LinphonePresenceNote object if successful, NULL otherwise.

◆ linphone_presence_person_get_user_data()

void* linphone_presence_person_get_user_data ( const LinphonePresencePerson person)

Gets the user data of a LinphonePresencePerson object.

Parameters
personThe LinphonePresencePerson object for which to get the user data.
Returns
A pointer to the user data.

◆ linphone_presence_person_new()

LinphonePresencePerson* linphone_presence_person_new ( const char *  id)

Creates a presence person.

Parameters
idThe id of the presence person to be created. Can be NULL to generate it automatically.
Returns
The created presence person, NULL on error.

◆ linphone_presence_person_ref()

LinphonePresencePerson* linphone_presence_person_ref ( LinphonePresencePerson person)

Increase the reference count of the LinphonePresencePerson object.

Parameters
personThe LinphonePresencePerson object for which the reference count is to be increased.
Returns
The LinphonePresencePerson object with the increased reference count.

◆ linphone_presence_person_set_id()

LinphoneStatus linphone_presence_person_set_id ( LinphonePresencePerson person,
const char *  id 
)

Sets the id of a presence person.

Parameters
personThe LinphonePresencePerson object for which to set the id.
idThe id string to set. Can be NULL to generate it automatically.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_person_set_user_data()

void linphone_presence_person_set_user_data ( LinphonePresencePerson person,
void *  user_data 
)

Sets the user data of a LinphonePresencePerson object.

Parameters
personThe LinphonePresencePerson object for which to set the user data.
user_dataA pointer to the user data to set.

◆ linphone_presence_person_unref()

LinphonePresencePerson* linphone_presence_person_unref ( LinphonePresencePerson person)

Decrease the reference count of the LinphonePresencePerson object and destroy it if it reaches 0.

Parameters
personThe LinphonePresencePerson object for which the reference count is to be decreased.
Returns
The LinphonePresencePerson object if the reference count is still positive, NULL if the object has been destroyed.

◆ linphone_presence_service_add_note()

LinphoneStatus linphone_presence_service_add_note ( LinphonePresenceService service,
LinphonePresenceNote note 
)

Adds a note to a presence service.

Parameters
serviceThe LinphonePresenceService object for which to add a note.
noteThe LinphonePresenceNote object to add to the service.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_service_clear_notes()

LinphoneStatus linphone_presence_service_clear_notes ( LinphonePresenceService service)

Clears the notes of a presence service.

Parameters
serviceThe LinphonePresenceService object for which to clear the notes.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_service_get_basic_status()

LinphonePresenceBasicStatus linphone_presence_service_get_basic_status ( const LinphonePresenceService service)

Gets the basic status of a presence service.

Parameters
serviceThe LinphonePresenceService object to get the basic status from.
Returns
The LinphonePresenceBasicStatus of the LinphonePresenceService object given as parameter.

◆ linphone_presence_service_get_contact()

char* linphone_presence_service_get_contact ( const LinphonePresenceService service)

Gets the contact of a presence service.

Parameters
serviceThe LinphonePresenceService object to get the contact from.
Returns
A pointer to a dynamically allocated string containing the contact, or NULL if no contact is found.

The returned string is to be freed by calling ms_free().

◆ linphone_presence_service_get_id()

char* linphone_presence_service_get_id ( const LinphonePresenceService service)

Gets the id of a presence service.

Parameters
serviceThe LinphonePresenceService object to get the id from.
Returns
A pointer to a dynamically allocated string containing the id, or NULL in case of error.

The returned string is to be freed by calling ms_free().

◆ linphone_presence_service_get_nb_notes()

unsigned int linphone_presence_service_get_nb_notes ( const LinphonePresenceService service)

Gets the number of notes included in the presence service.

Parameters
serviceThe LinphonePresenceService object to get the number of notes from.
Returns
The number of notes included in the LinphonePresenceService object.

◆ linphone_presence_service_get_nth_note()

LinphonePresenceNote* linphone_presence_service_get_nth_note ( const LinphonePresenceService service,
unsigned int  index 
)

Gets the nth note of a presence service.

Parameters
serviceThe LinphonePresenceService object to get the note from.
indexThe index of the note to get (the first note having the index 0).
Returns
A pointer to a LinphonePresenceNote object if successful, NULL otherwise.

◆ linphone_presence_service_get_service_descriptions()

bctbx_list_t* linphone_presence_service_get_service_descriptions ( const LinphonePresenceService service)

Gets the service descriptions of a presence service.

Parameters
serviceThe LinphonePresenceService object to get the contact from.
Returns
A containing the services descriptions.

The returned string is to be freed.

◆ linphone_presence_service_get_user_data()

void* linphone_presence_service_get_user_data ( const LinphonePresenceService service)

Gets the user data of a LinphonePresenceService object.

Parameters
serviceThe LinphonePresenceService object for which to get the user data.
Returns
A pointer to the user data.

◆ linphone_presence_service_new()

LinphonePresenceService* linphone_presence_service_new ( const char *  id,
LinphonePresenceBasicStatus  basic_status,
const char *  contact 
)

Creates a presence service.

Parameters
idThe id of the presence service to be created. Can be NULL to generate it automatically.
basic_statusThe LinphonePresenceBasicStatus to set for the LinphonePresenceService object.
contactThe contact string to set.
Returns
The created presence service, NULL on error.

The created presence service has the basic status 'closed'.

◆ linphone_presence_service_ref()

LinphonePresenceService* linphone_presence_service_ref ( LinphonePresenceService service)

Increase the reference count of the LinphonePresenceService object.

Parameters
serviceThe LinphonePresenceService object for which the reference count is to be increased.
Returns
The LinphonePresenceService object with the increased reference count.

◆ linphone_presence_service_set_basic_status()

LinphoneStatus linphone_presence_service_set_basic_status ( LinphonePresenceService service,
LinphonePresenceBasicStatus  basic_status 
)

Sets the basic status of a presence service.

Parameters
serviceThe LinphonePresenceService object for which to set the basic status.
basic_statusThe LinphonePresenceBasicStatus to set for the LinphonePresenceService object.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_service_set_contact()

LinphoneStatus linphone_presence_service_set_contact ( LinphonePresenceService service,
const char *  contact 
)

Sets the contact of a presence service.

Parameters
serviceThe LinphonePresenceService object for which to set the contact.
contactThe contact string to set.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_service_set_id()

LinphoneStatus linphone_presence_service_set_id ( LinphonePresenceService service,
const char *  id 
)

Sets the id of a presence service.

Parameters
serviceThe LinphonePresenceService object for which to set the id.
idThe id string to set. Can be NULL to generate it automatically.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_service_set_service_descriptions()

LinphoneStatus linphone_presence_service_set_service_descriptions ( LinphonePresenceService service,
bctbx_list_t *  descriptions 
)

Sets the service descriptions of a presence service.

Parameters
serviceThe LinphonePresenceService object for which to set the contact.
descriptionsThe service descriptions.
Returns
0 if successful, a value < 0 in case of error.

◆ linphone_presence_service_set_user_data()

void linphone_presence_service_set_user_data ( LinphonePresenceService service,
void *  user_data 
)

Sets the user data of a LinphonePresenceService object.

Parameters
serviceThe LinphonePresenceService object for which to set the user data.
user_dataA pointer to the user data to set.

◆ linphone_presence_service_unref()

LinphonePresenceService* linphone_presence_service_unref ( LinphonePresenceService service)

Decrease the reference count of the LinphonePresenceService object and destroy it if it reaches 0.

Parameters
serviceThe LinphonePresenceService object for which the reference count is to be decreased.
Returns
The LinphonePresenceService object if the reference count is still positive, NULL if the object has been destroyed.