Liblinphone
3.11.1
|
Macros | |
#define | linphone_friend_new_with_addr linphone_friend_new_with_address |
#define | linphone_friend_set_addr linphone_friend_set_address |
#define | linphone_friend_get_send_subscribe linphone_friend_subscribes_enabled |
#define | linphone_friend_send_subscribe linphone_friend_enable_subscribes |
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:
friends status changes are reported by callback LinphoneCoreVTable.notify_presence_recv
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()
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
#define linphone_friend_new_with_addr linphone_friend_new_with_address |
Contructor same as linphone_friend_new() + linphone_friend_set_address()
#define linphone_friend_set_addr linphone_friend_set_address |
Set LinphoneAddress for this friend
typedef struct _LinphoneFriend LinphoneFriend |
Represents a buddy, all presence actions like subscription and status change notification are performed on this object
typedef struct _LinphoneFriendList LinphoneFriendList |
The LinphoneFriendList object representing a list of friends.
typedef struct _LinphoneFriendListCbs LinphoneFriendListCbs |
An object to handle the callbacks for LinphoneFriend synchronization.
typedef void(* LinphoneFriendListCbsContactCreatedCb) (LinphoneFriendList *list, LinphoneFriend *lf) |
Callback used to notify a new contact has been created on the CardDAV server and downloaded locally
list | The LinphoneFriendList object the new contact is added to |
lf | The LinphoneFriend object that has been created |
typedef void(* LinphoneFriendListCbsContactDeletedCb) (LinphoneFriendList *list, LinphoneFriend *lf) |
Callback used to notify a contact has been deleted on the CardDAV server
list | The LinphoneFriendList object a contact has been removed from |
lf | The LinphoneFriend object that has been deleted |
typedef void(* LinphoneFriendListCbsContactUpdatedCb) (LinphoneFriendList *list, LinphoneFriend *new_friend, LinphoneFriend *old_friend) |
Callback used to notify a contact has been updated on the CardDAV server
list | The LinphoneFriendList object in which a contact has been updated |
new_friend | The new LinphoneFriend object corresponding to the updated contact |
old_friend | The old LinphoneFriend object before update |
typedef void(* LinphoneFriendListCbsSyncStateChangedCb) (LinphoneFriendList *list, LinphoneFriendListSyncStatus status, const char *msg) |
Callback used to notify the status of the synchronization has changed
list | The LinphoneFriendList object for which the status has changed |
status | The new synchronisation status |
msg | An additional information on the status update |
typedef enum _LinphoneFriendListStatus LinphoneFriendListStatus |
Enum describing the status of a LinphoneFriendList operation.
Enum describing the status of a CardDAV synchronization
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. Use by linphone_friend_set_inc_subscribe_policy()
Enum describing the status of a LinphoneFriendList operation.
Enum describing the status of a CardDAV synchronization
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 |
Activities as defined in section 3.2 of RFC 4480
Basic status as defined in section 4.1.4 of RFC 3863
void linphone_core_add_friend | ( | LinphoneCore * | lc, |
LinphoneFriend * | fr | ||
) |
Add a friend to the current buddy list, if subscription attribute is set, a SIP SUBSCRIBE message is sent.
lc | LinphoneCore object |
fr | LinphoneFriend to add |
void linphone_core_add_friend_list | ( | LinphoneCore * | lc, |
LinphoneFriendList * | list | ||
) |
Add a friend list.
[in] | lc | LinphoneCore object |
[in] | list | LinphoneFriendList object |
LinphoneFriend* linphone_core_create_friend | ( | LinphoneCore * | lc | ) |
Create a default LinphoneFriend.
[in] | lc | LinphoneCore object |
LinphoneFriendList* linphone_core_create_friend_list | ( | LinphoneCore * | lc | ) |
Create a new empty LinphoneFriendList object.
[in] | lc | LinphoneCore object. |
LinphoneFriend* linphone_core_create_friend_with_address | ( | LinphoneCore * | lc, |
const char * | address | ||
) |
Create a LinphoneFriend from the given address.
[in] | lc | LinphoneCore object |
[in] | address | A string containing the address to create the LinphoneFriend from |
LinphonePresenceActivity* linphone_core_create_presence_activity | ( | LinphoneCore * | lc, |
LinphonePresenceActivityType | acttype, | ||
const char * | description | ||
) |
Create a LinphonePresenceActivity with the given type and description.
[in] | lc | LinphoneCore object. |
[in] | acttype | The LinphonePresenceActivityType to set for the activity. |
[in] | description | An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added. |
LinphonePresenceModel* linphone_core_create_presence_model | ( | LinphoneCore * | lc | ) |
Create a default LinphonePresenceModel.
[in] | lc | LinphoneCore object. |
LinphonePresenceModel* linphone_core_create_presence_model_with_activity | ( | LinphoneCore * | lc, |
LinphonePresenceActivityType | acttype, | ||
const char * | description | ||
) |
Create a LinphonePresenceModel with the given activity type and activity description.
[in] | lc | LinphoneCore object. |
[in] | acttype | The LinphonePresenceActivityType to set for the activity of the created model. |
[in] | description | An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added. |
LinphonePresenceModel* linphone_core_create_presence_model_with_activity_and_note | ( | LinphoneCore * | lc, |
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.
[in] | lc | LinphoneCore object. |
[in] | acttype | The LinphonePresenceActivityType to set for the activity of the created model. |
[in] | description | An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added. |
[in] | note | The content of the note to be added to the created model. |
[in] | lang | The language of the note to be added to the created model. |
LinphonePresenceNote* linphone_core_create_presence_note | ( | LinphoneCore * | lc, |
const char * | content, | ||
const char * | lang | ||
) |
Create a LinphonePresenceNote with the given content and language.
[in] | lc | LinphoneCore object. |
[in] | content | The content of the note to be created. |
[in] | lang | The language of the note to be created. |
LinphonePresencePerson* linphone_core_create_presence_person | ( | LinphoneCore * | lc, |
const char * | id | ||
) |
Create a LinphonePresencePerson with the given id.
[in] | lc | LinphoneCore object |
[in] | id | The id of the person to be created. |
LinphonePresenceService* linphone_core_create_presence_service | ( | LinphoneCore * | lc, |
const char * | id, | ||
LinphonePresenceBasicStatus | basic_status, | ||
const char * | contact | ||
) |
Create a LinphonePresenceService with the given id, basic status and contact.
[in] | lc | LinphoneCore object. |
[in] | id | The id of the service to be created. |
[in] | basic_status | The basic status of the service to be created. |
[in] | contact | A string containing a contact information corresponding to the service to be created. |
LinphoneFriend* linphone_core_find_friend | ( | const LinphoneCore * | lc, |
const LinphoneAddress * | addr | ||
) |
Search a LinphoneFriend by its address.
[in] | lc | LinphoneCore object. |
[in] | addr | The address to use to search the friend. |
LinphoneFriendList* linphone_core_get_default_friend_list | ( | const LinphoneCore * | lc | ) |
Retrieves the first list of LinphoneFriend from the core.
[in] | lc | LinphoneCore object |
LinphoneFriend* linphone_core_get_friend_by_address | ( | const LinphoneCore * | lc, |
const char * | addr | ||
) |
Search a LinphoneFriend by its address.
[in] | lc | LinphoneCore object. |
[in] | addr | The address to use to search the friend. |
LinphoneFriend* linphone_core_get_friend_by_ref_key | ( | const LinphoneCore * | lc, |
const char * | key | ||
) |
Search a LinphoneFriend by its reference key.
[in] | lc | LinphoneCore object. |
[in] | key | The reference key to use to search the friend. |
const bctbx_list_t* linphone_core_get_friend_list | ( | const LinphoneCore * | lc | ) |
Get Buddy list of LinphoneFriend
[in] | lc | LinphoneCore object |
const bctbx_list_t* linphone_core_get_friends_lists | ( | const LinphoneCore * | lc | ) |
Retrieves the list of LinphoneFriendList from the core.
[in] | lc | LinphoneCore object |
LinphoneOnlineStatus linphone_core_get_presence_info | ( | const LinphoneCore * | lc | ) |
Get my presence status
[in] | lc | LinphoneCore object |
LinphonePresenceModel* linphone_core_get_presence_model | ( | const LinphoneCore * | lc | ) |
Get my presence model
[in] | lc | LinphoneCore object |
void linphone_core_interpret_friend_uri | ( | LinphoneCore * | lc, |
const char * | uri, | ||
char ** | result | ||
) |
void linphone_core_notify_all_friends | ( | LinphoneCore * | lc, |
LinphonePresenceModel * | presence | ||
) |
Notify all friends that have subscribed
lc | LinphoneCore object |
presence | LinphonePresenceModel to notify |
void linphone_core_reject_subscriber | ( | LinphoneCore * | lc, |
LinphoneFriend * | lf | ||
) |
Black list a friend. same as linphone_friend_set_inc_subscribe_policy() with LinphoneSPDeny policy;
lc | LinphoneCore object |
lf | LinphoneFriend to add |
void linphone_core_remove_friend | ( | LinphoneCore * | lc, |
LinphoneFriend * | fr | ||
) |
Removes a friend from the buddy list
lc | LinphoneCore object |
fr | LinphoneFriend to remove |
void linphone_core_remove_friend_list | ( | LinphoneCore * | lc, |
LinphoneFriendList * | list | ||
) |
Removes a friend list.
[in] | lc | LinphoneCore object |
[in] | list | LinphoneFriendList object |
void linphone_core_set_presence_info | ( | LinphoneCore * | lc, |
int | minutes_away, | ||
const char * | alternative_contact, | ||
LinphoneOnlineStatus | os | ||
) |
Set my presence status
[in] | lc | LinphoneCore object |
[in] | minutes_away | how long in away |
[in] | alternative_contact | sip uri used to redirect call in state #LinphoneStatusMoved |
[in] | os | #LinphoneOnlineStatus |
void linphone_core_set_presence_model | ( | LinphoneCore * | lc, |
LinphonePresenceModel * | presence | ||
) |
Set my presence model
[in] | lc | LinphoneCore object |
[in] | presence | LinphonePresenceModel |
void linphone_friend_add_address | ( | LinphoneFriend * | lf, |
const LinphoneAddress * | addr | ||
) |
Adds an address in this friend
lf | LinphoneFriend object |
addr | LinphoneAddress object |
void linphone_friend_add_phone_number | ( | LinphoneFriend * | lf, |
const char * | phone | ||
) |
Adds a phone number in this friend
lf | LinphoneFriend object |
phone | number to add |
bool_t linphone_friend_create_vcard | ( | LinphoneFriend * | fr, |
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
[in] | fr | LinphoneFriend object |
[in] | name | The full name of the friend or NULL to use the one from the friend's SIP URI |
void linphone_friend_destroy | ( | LinphoneFriend * | lf | ) |
Destroy a LinphoneFriend.
lf | LinphoneFriend object |
void linphone_friend_done | ( | LinphoneFriend * | fr | ) |
Commits modification made to the friend configuration.
fr | LinphoneFriend object |
void linphone_friend_edit | ( | LinphoneFriend * | fr | ) |
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 address or subscription policy and so on). Once the modifications are done, then the application must call linphone_friend_done() to commit the changes.
int linphone_friend_enable_subscribes | ( | LinphoneFriend * | fr, |
bool_t | val | ||
) |
Configure LinphoneFriend to subscribe to presence information
fr | LinphoneFriend object |
val | if TRUE this friend will receive subscription message |
const LinphoneAddress* linphone_friend_get_address | ( | const LinphoneFriend * | lf | ) |
Get address of this friend.
lf | LinphoneFriend object |
const bctbx_list_t* linphone_friend_get_addresses | ( | const LinphoneFriend * | lf | ) |
Returns a list of LinphoneAddress for this friend
lf | LinphoneFriend object |
LinphoneCore* linphone_friend_get_core | ( | const LinphoneFriend * | fr | ) |
Returns the LinphoneCore object managing this friend, if any.
[in] | fr | LinphoneFriend object |
LinphoneSubscribePolicy linphone_friend_get_inc_subscribe_policy | ( | const LinphoneFriend * | lf | ) |
get current subscription policy for this LinphoneFriend
lf | LinphoneFriend object |
const char* linphone_friend_get_name | ( | const LinphoneFriend * | lf | ) |
Get the display name for this friend
lf | LinphoneFriend object |
bctbx_list_t* linphone_friend_get_phone_numbers | ( | LinphoneFriend * | lf | ) |
Returns a list of phone numbers for this friend
lf | LinphoneFriend object |
const LinphonePresenceModel* linphone_friend_get_presence_model | ( | const LinphoneFriend * | lf | ) |
Get the presence model of a friend
[in] | lf | A LinphoneFriend object |
const LinphonePresenceModel* linphone_friend_get_presence_model_for_uri_or_tel | ( | const LinphoneFriend * | lf, |
const char * | uri_or_tel | ||
) |
Get the presence model for a specific SIP URI or phone number of a friend
[in] | lf | A LinphoneFriend object |
[in] | uri_or_tel | The SIP URI or phone number for which to get the presence model |
const char* linphone_friend_get_ref_key | ( | const LinphoneFriend * | lf | ) |
Get the reference key of a friend.
[in] | lf | LinphoneFriend object. |
LinphoneOnlineStatus linphone_friend_get_status | ( | const LinphoneFriend * | lf | ) |
Get the status of a friend
[in] | lf | A LinphoneFriend object |
LinphoneSubscriptionState linphone_friend_get_subscription_state | ( | const LinphoneFriend * | lf | ) |
Get subscription state of a friend
[in] | lf | A LinphoneFriend object |
void* linphone_friend_get_user_data | ( | const LinphoneFriend * | lf | ) |
Retrieve user data associated with friend.
LinphoneVcard* linphone_friend_get_vcard | ( | LinphoneFriend * | fr | ) |
Returns the vCard object associated to this friend, if any
[in] | fr | LinphoneFriend object |
bool_t linphone_friend_in_list | ( | const LinphoneFriend * | lf | ) |
Check that the given friend is in a friend list.
[in] | lf | LinphoneFriend object. |
bool_t linphone_friend_is_presence_received | ( | const LinphoneFriend * | lf | ) |
Tells whether we already received presence information for a friend.
[in] | lf | A LinphoneFriend object |
LinphoneFriendListStatus linphone_friend_list_add_friend | ( | LinphoneFriendList * | list, |
LinphoneFriend * | lf | ||
) |
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.
[in] | list | LinphoneFriendList object. |
[in] | lf | LinphoneFriend object to add to the friend list. |
LinphoneFriendListStatus linphone_friend_list_add_local_friend | ( | LinphoneFriendList * | list, |
LinphoneFriend * | lf | ||
) |
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.
[in] | list | LinphoneFriendList object. |
[in] | lf | LinphoneFriend object to add to the friend list. |
LinphoneFriendListCbsContactCreatedCb linphone_friend_list_cbs_get_contact_created | ( | const LinphoneFriendListCbs * | cbs | ) |
Get the contact created callback.
[in] | cbs | LinphoneFriendListCbs object. |
LinphoneFriendListCbsContactDeletedCb linphone_friend_list_cbs_get_contact_deleted | ( | const LinphoneFriendListCbs * | cbs | ) |
Get the contact deleted callback.
[in] | cbs | LinphoneFriendListCbs object. |
LinphoneFriendListCbsContactUpdatedCb linphone_friend_list_cbs_get_contact_updated | ( | const LinphoneFriendListCbs * | cbs | ) |
Get the contact updated callback.
[in] | cbs | LinphoneFriendListCbs object. |
LinphoneFriendListCbsSyncStateChangedCb linphone_friend_list_cbs_get_sync_status_changed | ( | const LinphoneFriendListCbs * | cbs | ) |
Get the sync status changed callback.
[in] | cbs | LinphoneFriendListCbs object. |
void* linphone_friend_list_cbs_get_user_data | ( | const LinphoneFriendListCbs * | cbs | ) |
Retrieve the user pointer associated with a LinphoneFriendListCbs object.
[in] | cbs | LinphoneFriendListCbs object. |
LinphoneFriendListCbs* linphone_friend_list_cbs_ref | ( | LinphoneFriendListCbs * | cbs | ) |
Acquire a reference to a LinphoneFriendListCbs object.
[in] | cbs | LinphoneFriendListCbs object. |
void linphone_friend_list_cbs_set_contact_created | ( | LinphoneFriendListCbs * | cbs, |
LinphoneFriendListCbsContactCreatedCb | cb | ||
) |
Set the contact created callback.
[in] | cbs | LinphoneFriendListCbs object. |
[in] | cb | The contact created to be used. |
void linphone_friend_list_cbs_set_contact_deleted | ( | LinphoneFriendListCbs * | cbs, |
LinphoneFriendListCbsContactDeletedCb | cb | ||
) |
Set the contact deleted callback.
[in] | cbs | LinphoneFriendListCbs object. |
[in] | cb | The contact deleted to be used. |
void linphone_friend_list_cbs_set_contact_updated | ( | LinphoneFriendListCbs * | cbs, |
LinphoneFriendListCbsContactUpdatedCb | cb | ||
) |
Set the contact updated callback.
[in] | cbs | LinphoneFriendListCbs object. |
[in] | cb | The contact updated to be used. |
void linphone_friend_list_cbs_set_sync_status_changed | ( | LinphoneFriendListCbs * | cbs, |
LinphoneFriendListCbsSyncStateChangedCb | cb | ||
) |
Set the contact updated callback.
[in] | cbs | LinphoneFriendListCbs object. |
[in] | cb | The sync status changed to be used. |
void linphone_friend_list_cbs_set_user_data | ( | LinphoneFriendListCbs * | cbs, |
void * | ud | ||
) |
Assign a user pointer to a LinphoneFriendListCbs object.
[in] | cbs | LinphoneFriendListCbs object. |
[in] | ud | The user pointer to associate with the LinphoneFriendListCbs object. |
void linphone_friend_list_cbs_unref | ( | LinphoneFriendListCbs * | cbs | ) |
Release a reference to a LinphoneFriendListCbs object.
[in] | cbs | LinphoneFriendListCbs object. |
void linphone_friend_list_enable_subscriptions | ( | LinphoneFriendList * | list, |
bool_t | enabled | ||
) |
Enable subscription to NOTIFYes of all friends list
[in] | list | the LinphoneFriendList object |
[in] | enabled | should subscription be enabled or not |
void linphone_friend_list_export_friends_as_vcard4_file | ( | LinphoneFriendList * | list, |
const char * | vcard_file | ||
) |
Creates and export LinphoneFriend objects from LinphoneFriendList to a file using vCard 4 format
[in] | list | the LinphoneFriendList object |
[in] | vcard_file | the path to a file that will contain the vCards |
LinphoneFriend* linphone_friend_list_find_friend_by_address | ( | const LinphoneFriendList * | list, |
const LinphoneAddress * | address | ||
) |
Find a friend in the friend list using a LinphoneAddress.
[in] | list | LinphoneFriendList object. |
[in] | address | LinphoneAddress object of the friend we want to search for. |
LinphoneFriend* linphone_friend_list_find_friend_by_ref_key | ( | const LinphoneFriendList * | list, |
const char * | ref_key | ||
) |
Find a friend in the friend list using a ref key.
[in] | list | LinphoneFriendList object. |
[in] | ref_key | The ref key string of the friend we want to search for. |
LinphoneFriend* linphone_friend_list_find_friend_by_uri | ( | const LinphoneFriendList * | list, |
const char * | uri | ||
) |
Find a friend in the friend list using an URI string.
[in] | list | LinphoneFriendList object. |
[in] | uri | A string containing the URI of the friend we want to search for. |
LinphoneFriendListCbs* linphone_friend_list_get_callbacks | ( | const LinphoneFriendList * | list | ) |
Get the LinphoneFriendListCbs object associated with a LinphoneFriendList.
[in] | list | LinphoneFriendList object |
LinphoneCore* linphone_friend_list_get_core | ( | const LinphoneFriendList * | list | ) |
Returns the LinphoneCore object attached to this LinphoneFriendList.
[in] | list | LinphoneFriendList object. |
const char* linphone_friend_list_get_display_name | ( | const LinphoneFriendList * | list | ) |
Get the display name of the friend list.
[in] | list | LinphoneFriendList object. |
const bctbx_list_t* linphone_friend_list_get_friends | ( | const LinphoneFriendList * | list | ) |
Retrieves the list of LinphoneFriend from this LinphoneFriendList.
[in] | list | LinphoneFriendList object |
const LinphoneAddress* linphone_friend_list_get_rls_address | ( | const LinphoneFriendList * | list | ) |
Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
[in] | list | LinphoneFriendList object. |
const char* linphone_friend_list_get_rls_uri | ( | const LinphoneFriendList * | list | ) |
Get the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
[in] | list | LinphoneFriendList object. |
const char* linphone_friend_list_get_uri | ( | const LinphoneFriendList * | list | ) |
Get the URI associated with the friend list.
[in] | list | LinphoneFriendList object. |
void* linphone_friend_list_get_user_data | ( | const LinphoneFriendList * | list | ) |
Retrieve the user pointer associated with the friend list.
[in] | list | LinphoneFriendList object. |
int linphone_friend_list_import_friends_from_vcard4_buffer | ( | LinphoneFriendList * | list, |
const char * | vcard_buffer | ||
) |
Creates and adds LinphoneFriend objects to LinphoneFriendList from a buffer that contains the vCard(s) to parse
[in] | list | the LinphoneFriendList object |
[in] | vcard_buffer | the buffer that contains the vCard(s) to parse |
int linphone_friend_list_import_friends_from_vcard4_file | ( | LinphoneFriendList * | list, |
const char * | vcard_file | ||
) |
Creates and adds LinphoneFriend objects to LinphoneFriendList from a file that contains the vCard(s) to parse
[in] | list | the LinphoneFriendList object |
[in] | vcard_file | the path to a file that contains the vCard(s) to parse |
void linphone_friend_list_notify_presence | ( | LinphoneFriendList * | 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).
[in] | list | LinphoneFriendList object. |
[in] | presence | LinphonePresenceModel object. |
LinphoneFriendList* linphone_friend_list_ref | ( | LinphoneFriendList * | list | ) |
Acquire a reference to the friend list.
[in] | list | LinphoneFriendList object. |
LinphoneFriendListStatus linphone_friend_list_remove_friend | ( | LinphoneFriendList * | list, |
LinphoneFriend * | lf | ||
) |
Remove a friend from a friend list.
[in] | list | LinphoneFriendList object. |
[in] | lf | LinphoneFriend object to remove from the friend list. |
void linphone_friend_list_set_display_name | ( | LinphoneFriendList * | list, |
const char * | display_name | ||
) |
Set the display name of the friend list.
[in] | list | LinphoneFriendList object. |
[in] | display_name | The new display name of the friend list. |
void linphone_friend_list_set_rls_address | ( | LinphoneFriendList * | list, |
const LinphoneAddress * | rls_addr | ||
) |
Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
[in] | list | LinphoneFriendList object. |
[in] | rls_addr | The RLS URI to associate with the friend list. |
void linphone_friend_list_set_rls_uri | ( | LinphoneFriendList * | list, |
const char * | rls_uri | ||
) |
Set the RLS (Resource List Server) URI associated with the friend list to subscribe to these friends presence.
[in] | list | LinphoneFriendList object. |
[in] | rls_uri | The RLS URI to associate with the friend list. |
void linphone_friend_list_set_uri | ( | LinphoneFriendList * | list, |
const char * | uri | ||
) |
Set the URI associated with the friend list.
[in] | list | LinphoneFriendList object. |
[in] | uri | The URI to associate with the friend list. |
void linphone_friend_list_set_user_data | ( | LinphoneFriendList * | list, |
void * | ud | ||
) |
Assign a user pointer to the friend list.
[in] | list | LinphoneFriendList object. |
[in] | ud | The user pointer to associate with the friend list. |
void linphone_friend_list_synchronize_friends_from_server | ( | LinphoneFriendList * | list | ) |
Starts a CardDAV synchronization using value set using linphone_friend_list_set_uri.
[in] | list | LinphoneFriendList object. |
void linphone_friend_list_unref | ( | LinphoneFriendList * | list | ) |
Release reference to the friend list.
[in] | list | LinphoneFriendList object. |
void linphone_friend_list_update_dirty_friends | ( | LinphoneFriendList * | list | ) |
Goes through all the LinphoneFriend that are dirty and does a CardDAV PUT to update the server.
[in] | list | LinphoneFriendList object. |
void linphone_friend_list_update_revision | ( | LinphoneFriendList * | list, |
int | rev | ||
) |
Sets the revision from the last synchronization.
[in] | list | LinphoneFriendList object. |
[in] | rev | The revision |
void linphone_friend_list_update_subscriptions | ( | LinphoneFriendList * | 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.
[in] | list | the friend list |
LINPHONE_DEPRECATED LinphoneFriend* linphone_friend_new | ( | void | ) |
LinphoneFriend* linphone_friend_new_from_vcard | ( | LinphoneVcard * | vcard | ) |
Contructor same as linphone_friend_new() + linphone_friend_set_address()
vcard | a vCard object |
LINPHONE_DEPRECATED LinphoneFriend* linphone_friend_new_with_address | ( | const char * | addr | ) |
Contructor same as linphone_friend_new() + linphone_friend_set_address()
addr | a buddy address, must be a sip uri like sip:joe@s ip.l inpho ne.o rg |
LinphoneFriend* linphone_friend_ref | ( | LinphoneFriend * | lf | ) |
Acquire a reference to the linphone friend.
[in] | lf | LinphoneFriend object |
void linphone_friend_remove_address | ( | LinphoneFriend * | lf, |
const LinphoneAddress * | addr | ||
) |
Removes an address in this friend
lf | LinphoneFriend object |
addr | LinphoneAddress object |
void linphone_friend_remove_phone_number | ( | LinphoneFriend * | lf, |
const char * | phone | ||
) |
Removes a phone number in this friend
lf | LinphoneFriend object |
phone | number to remove |
void linphone_friend_save | ( | LinphoneFriend * | fr, |
LinphoneCore * | lc | ||
) |
Saves a friend either in database if configured, otherwise in linphonerc
fr | the linphone friend to save |
lc | the linphone core |
int linphone_friend_set_address | ( | LinphoneFriend * | fr, |
const LinphoneAddress * | address | ||
) |
Set LinphoneAddress for this friend
fr | LinphoneFriend object |
address | LinphoneAddress |
int linphone_friend_set_inc_subscribe_policy | ( | LinphoneFriend * | fr, |
LinphoneSubscribePolicy | pol | ||
) |
Configure incoming subscription policy for this friend.
fr | LinphoneFriend object |
pol | LinphoneSubscribePolicy policy to apply. |
int linphone_friend_set_name | ( | LinphoneFriend * | lf, |
const char * | name | ||
) |
Set the display name for this friend
lf | LinphoneFriend object |
name |
void linphone_friend_set_presence_model | ( | LinphoneFriend * | lf, |
LinphonePresenceModel * | presence | ||
) |
Set the presence model of a friend
[in] | lf | A LinphoneFriend object |
[in] | presence | The LinphonePresenceModel object to set for the friend |
void linphone_friend_set_presence_model_for_uri_or_tel | ( | LinphoneFriend * | lf, |
const char * | uri_or_tel, | ||
LinphonePresenceModel * | presence | ||
) |
Set the presence model for a specific SIP URI or phone number of a friend
[in] | lf | A LinphoneFriend object |
[in] | uri_or_tel | The SIP URI or phone number for which to set the presence model |
[in] | presence | The LinphonePresenceModel object to set |
void linphone_friend_set_ref_key | ( | LinphoneFriend * | lf, |
const char * | key | ||
) |
Set the reference key of a friend.
[in] | lf | LinphoneFriend object. |
[in] | key | The reference key to use for the friend. |
void linphone_friend_set_user_data | ( | LinphoneFriend * | lf, |
void * | data | ||
) |
Store user pointer to friend object.
void linphone_friend_set_vcard | ( | LinphoneFriend * | fr, |
LinphoneVcard * | vcard | ||
) |
Binds a vCard object to a friend
[in] | fr | LinphoneFriend object |
[in] | vcard | The vCard object to bind |
bool_t linphone_friend_subscribes_enabled | ( | const LinphoneFriend * | lf | ) |
get subscription flag value
lf | LinphoneFriend object |
void linphone_friend_unref | ( | LinphoneFriend * | lf | ) |
Release a reference to the linphone friend.
[in] | lf | LinphoneFriend object |
const char* linphone_presence_activity_get_description | ( | const LinphonePresenceActivity * | activity | ) |
Gets the description of a presence activity.
[in] | activity | A pointer to the LinphonePresenceActivity for which to get the description. |
LinphonePresenceActivityType linphone_presence_activity_get_type | ( | const LinphonePresenceActivity * | activity | ) |
Gets the activity type of a presence activity.
[in] | activity | A pointer to the LinphonePresenceActivity for which to get the type. |
void* linphone_presence_activity_get_user_data | ( | const LinphonePresenceActivity * | activity | ) |
Gets the user data of a LinphonePresenceActivity object.
[in] | activity | The LinphonePresenceActivity object for which to get the user data. |
LinphonePresenceActivity* linphone_presence_activity_new | ( | LinphonePresenceActivityType | acttype, |
const char * | description | ||
) |
Creates a presence activity.
[in] | acttype | The LinphonePresenceActivityType to set for the activity. |
[in] | description | An additional description of the activity to set for the activity. Can be NULL if no additional description is to be added. |
LinphonePresenceActivity* linphone_presence_activity_ref | ( | LinphonePresenceActivity * | activity | ) |
Increase the reference count of the LinphonePresenceActivity object.
[in] | activity | The LinphonePresenceActivity object for which the reference count is to be increased. |
int linphone_presence_activity_set_description | ( | LinphonePresenceActivity * | activity, |
const char * | description | ||
) |
Sets the description of a presence activity.
[in] | activity | The LinphonePresenceActivity object for which to set the description. |
[in] | description | An additional description of the activity. Can be NULL if no additional description is to be added. |
int linphone_presence_activity_set_type | ( | LinphonePresenceActivity * | activity, |
LinphonePresenceActivityType | acttype | ||
) |
Sets the type of activity of a presence activity.
[in] | activity | The LinphonePresenceActivity for which to set for the activity type. |
[in] | acttype | The activity type to set for the activity. |
void linphone_presence_activity_set_user_data | ( | LinphonePresenceActivity * | activity, |
void * | user_data | ||
) |
Sets the user data of a LinphonePresenceActivity object.
[in] | activity | The LinphonePresenceActivity object for which to set the user data. |
[in] | user_data | A pointer to the user data to set. |
char* linphone_presence_activity_to_string | ( | const LinphonePresenceActivity * | activity | ) |
Gets the string representation of a presence activity.
[in] | activity | A pointer to the LinphonePresenceActivity object for which to get a string representation. |
The returned string is to be freed by calling ms_free().
LinphonePresenceActivity* linphone_presence_activity_unref | ( | LinphonePresenceActivity * | activity | ) |
Decrease the reference count of the LinphonePresenceActivity object and destroy it if it reaches 0.
[in] | activity | The LinphonePresenceActivity object for which the reference count is to be decreased. |
int linphone_presence_model_add_activity | ( | LinphonePresenceModel * | model, |
LinphonePresenceActivity * | activity | ||
) |
Adds an activity to a presence model.
[in] | model | The LinphonePresenceModel object for which to add an activity. |
[in] | activity | The LinphonePresenceActivity object to add to the model. |
int linphone_presence_model_add_note | ( | LinphonePresenceModel * | model, |
const char * | note_content, | ||
const char * | lang | ||
) |
Adds a note to a presence model.
[in] | model | The LinphonePresenceModel object to add a note to. |
[in] | note_content | The note to be added to the presence model. |
[in] | lang | The language of the note to be added. Can be NULL if no language is to be specified for the note. |
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.
int linphone_presence_model_add_person | ( | LinphonePresenceModel * | model, |
LinphonePresencePerson * | person | ||
) |
Adds a person to a presence model.
[in] | model | The LinphonePresenceModel object for which to add a person. |
[in] | person | The LinphonePresencePerson object to add to the model. |
int linphone_presence_model_add_service | ( | LinphonePresenceModel * | model, |
LinphonePresenceService * | service | ||
) |
Adds a service to a presence model.
[in] | model | The LinphonePresenceModel object for which to add a service. |
[in] | service | The LinphonePresenceService object to add to the model. |
int linphone_presence_model_clear_activities | ( | LinphonePresenceModel * | model | ) |
Clears the activities of a presence model.
[in] | model | The LinphonePresenceModel object for which to clear the activities. |
int linphone_presence_model_clear_notes | ( | LinphonePresenceModel * | model | ) |
Clears all the notes of a presence model.
[in] | model | The LinphonePresenceModel for which to clear notes. |
int linphone_presence_model_clear_persons | ( | LinphonePresenceModel * | model | ) |
Clears the persons of a presence model.
[in] | model | The LinphonePresenceModel object for which to clear the persons. |
int linphone_presence_model_clear_services | ( | LinphonePresenceModel * | model | ) |
Clears the services of a presence model.
[in] | model | The LinphonePresenceModel object for which to clear the services. |
LinphonePresenceActivity* linphone_presence_model_get_activity | ( | const LinphonePresenceModel * | model | ) |
Gets the first activity of a presence model (there is usually only one).
[in] | model | The LinphonePresenceModel object to get the activity from. |
LinphonePresenceBasicStatus linphone_presence_model_get_basic_status | ( | const LinphonePresenceModel * | model | ) |
Gets the basic status of a presence model.
[in] | model | The LinphonePresenceModel object to get the basic status from. |
char* linphone_presence_model_get_contact | ( | const LinphonePresenceModel * | model | ) |
Gets the contact of a presence model.
[in] | model | The LinphonePresenceModel object to get the contact from. |
The returned string is to be freed by calling ms_free().
unsigned int linphone_presence_model_get_nb_activities | ( | const LinphonePresenceModel * | model | ) |
Gets the number of activities included in the presence model.
[in] | model | The LinphonePresenceModel object to get the number of activities from. |
unsigned int linphone_presence_model_get_nb_persons | ( | const LinphonePresenceModel * | model | ) |
Gets the number of persons included in the presence model.
[in] | model | The LinphonePresenceModel object to get the number of persons from. |
unsigned int linphone_presence_model_get_nb_services | ( | const LinphonePresenceModel * | model | ) |
Gets the number of services included in the presence model.
[in] | model | The LinphonePresenceModel object to get the number of services from. |
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).
[in] | model | The LinphonePresenceModel object to get the note from. |
[in] | lang | The 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. |
LinphonePresenceActivity* linphone_presence_model_get_nth_activity | ( | const LinphonePresenceModel * | model, |
unsigned int | idx | ||
) |
Gets the nth activity of a presence model.
[in] | model | The LinphonePresenceModel object to get the activity from. |
[in] | idx | The index of the activity to get (the first activity having the index 0). |
LinphonePresencePerson* linphone_presence_model_get_nth_person | ( | const LinphonePresenceModel * | model, |
unsigned int | idx | ||
) |
Gets the nth person of a presence model.
[in] | model | The LinphonePresenceModel object to get the person from. |
[in] | idx | The index of the person to get (the first person having the index 0). |
LinphonePresenceService* linphone_presence_model_get_nth_service | ( | const LinphonePresenceModel * | model, |
unsigned int | idx | ||
) |
Gets the nth service of a presence model.
[in] | model | The LinphonePresenceModel object to get the service from. |
[in] | idx | The index of the service to get (the first service having the index 0). |
const LinphoneAddress* linphone_presence_model_get_presentity | ( | const LinphonePresenceModel * | model | ) |
Gets the presentity of a presence model.
[in] | model | The LinphonePresenceModel object to get the contact from. |
time_t linphone_presence_model_get_timestamp | ( | const LinphonePresenceModel * | model | ) |
Gets the timestamp of a presence model.
[in] | model | The LinphonePresenceModel object to get the timestamp from. |
void* linphone_presence_model_get_user_data | ( | const LinphonePresenceModel * | model | ) |
Gets the user data of a LinphonePresenceModel object.
[in] | model | The LinphonePresenceModel object for which to get the user data. |
LinphonePresenceModel* linphone_presence_model_new | ( | void | ) |
Creates a default presence model.
The created presence model is considered 'offline'.
LinphonePresenceModel* linphone_presence_model_new_with_activity | ( | LinphonePresenceActivityType | activity, |
const char * | description | ||
) |
Creates a presence model specifying an activity.
[in] | activity | The activity to set for the created presence model. |
[in] | description | An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description. |
The created presence model has the activity specified in the parameters.
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.
[in] | activity | The activity to set for the created presence model. |
[in] | description | An additional description of the activity (mainly useful for the 'other' activity). Set it to NULL to not add a description. |
[in] | note | An additional note giving additional information about the contact presence. |
[in] | lang | The language the note is written in. It can be set to NULL in order to not specify the language of the note. |
The created presence model has the activity and the note specified in the parameters.
LinphonePresenceModel* linphone_presence_model_ref | ( | LinphonePresenceModel * | model | ) |
Increase the reference count of the LinphonePresenceModel object.
[in] | model | The LinphonePresenceModel object for which the reference count is to be increased. |
int linphone_presence_model_set_activity | ( | LinphonePresenceModel * | model, |
LinphonePresenceActivityType | activity, | ||
const char * | description | ||
) |
Sets the activity of a presence model (limits to only one activity).
[in] | model | The LinphonePresenceModel object for which to set the activity. |
[in] | activity | The LinphonePresenceActivityType to set for the model. |
[in] | description | An additional description of the activity to set for the model. Can be NULL if no additional description is to be added. |
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().
int linphone_presence_model_set_basic_status | ( | LinphonePresenceModel * | model, |
LinphonePresenceBasicStatus | basic_status | ||
) |
Sets the basic status of a presence model.
[in] | model | The LinphonePresenceModel object for which to set the basic status. |
[in] | basic_status | The LinphonePresenceBasicStatus to set for the LinphonePresenceModel object. |
int linphone_presence_model_set_contact | ( | LinphonePresenceModel * | model, |
const char * | contact | ||
) |
Sets the contact of a presence model.
[in] | model | The LinphonePresenceModel object for which to set the contact. |
[in] | contact | The contact string to set. |
int linphone_presence_model_set_presentity | ( | LinphonePresenceModel * | model, |
const LinphoneAddress * | presentity | ||
) |
Sets the presentity of a presence model.
[in] | model | The LinphonePresenceModel object for which to set the contact. |
[in] | presentity | The presentity address to set (presentity is copied). |
void linphone_presence_model_set_user_data | ( | LinphonePresenceModel * | model, |
void * | user_data | ||
) |
Sets the user data of a LinphonePresenceModel object.
[in] | model | The LinphonePresenceModel object for which to set the user data. |
[in] | user_data | A pointer to the user data to set. |
LinphonePresenceModel* linphone_presence_model_unref | ( | LinphonePresenceModel * | model | ) |
Decrease the reference count of the LinphonePresenceModel object and destroy it if it reaches 0.
[in] | model | The LinphonePresenceModel object for which the reference count is to be decreased. |
const char* linphone_presence_note_get_content | ( | const LinphonePresenceNote * | note | ) |
Gets the content of a presence note.
[in] | note | A pointer to the LinphonePresenceNote for which to get the content. |
const char* linphone_presence_note_get_lang | ( | const LinphonePresenceNote * | note | ) |
Gets the language of a presence note.
[in] | note | A pointer to the LinphonePresenceNote for which to get the language. |
void* linphone_presence_note_get_user_data | ( | const LinphonePresenceNote * | note | ) |
Gets the user data of a LinphonePresenceNote object.
[in] | note | The LinphonePresenceNote object for which to get the user data. |
LinphonePresenceNote* linphone_presence_note_new | ( | const char * | content, |
const char * | lang | ||
) |
Creates a presence note.
[in] | content | The content of the note to be created. |
[in] | lang | The language of the note to be created. Can be NULL if no language is to be specified for the note. |
LinphonePresenceNote* linphone_presence_note_ref | ( | LinphonePresenceNote * | note | ) |
Increase the reference count of the LinphonePresenceNote object.
[in] | note | The LinphonePresenceNote object for which the reference count is to be increased. |
int linphone_presence_note_set_content | ( | LinphonePresenceNote * | note, |
const char * | content | ||
) |
Sets the content of a presence note.
[in] | note | The LinphonePresenceNote object for which to set the content. |
[in] | content | The content of the note. |
int linphone_presence_note_set_lang | ( | LinphonePresenceNote * | note, |
const char * | lang | ||
) |
Sets the language of a presence note.
[in] | note | The LinphonePresenceNote object for which to set the language. |
[in] | lang | The language of the note. |
void linphone_presence_note_set_user_data | ( | LinphonePresenceNote * | note, |
void * | user_data | ||
) |
Sets the user data of a LinphonePresenceNote object.
[in] | note | The LinphonePresenceNote object for which to set the user data. |
[in] | user_data | A pointer to the user data to set. |
LinphonePresenceNote* linphone_presence_note_unref | ( | LinphonePresenceNote * | note | ) |
Decrease the reference count of the LinphonePresenceNote object and destroy it if it reaches 0.
[in] | note | The LinphonePresenceNote object for which the reference count is to be decreased. |
int linphone_presence_person_add_activities_note | ( | LinphonePresencePerson * | person, |
LinphonePresenceNote * | note | ||
) |
Adds an activities note to a presence person.
[in] | person | The LinphonePresencePerson object for which to add an activities note. |
[in] | note | The LinphonePresenceNote object to add to the person. |
int linphone_presence_person_add_activity | ( | LinphonePresencePerson * | person, |
LinphonePresenceActivity * | activity | ||
) |
Adds an activity to a presence person.
[in] | person | The LinphonePresencePerson object for which to add an activity. |
[in] | activity | The LinphonePresenceActivity object to add to the person. |
int linphone_presence_person_add_note | ( | LinphonePresencePerson * | person, |
LinphonePresenceNote * | note | ||
) |
Adds a note to a presence person.
[in] | person | The LinphonePresencePerson object for which to add a note. |
[in] | note | The LinphonePresenceNote object to add to the person. |
int linphone_presence_person_clear_activities | ( | LinphonePresencePerson * | person | ) |
Clears the activities of a presence person.
[in] | person | The LinphonePresencePerson object for which to clear the activities. |
int linphone_presence_person_clear_activities_notes | ( | LinphonePresencePerson * | person | ) |
Clears the activities notes of a presence person.
[in] | person | The LinphonePresencePerson object for which to clear the activities notes. |
int linphone_presence_person_clear_notes | ( | LinphonePresencePerson * | person | ) |
Clears the notes of a presence person.
[in] | person | The LinphonePresencePerson object for which to clear the notes. |
char* linphone_presence_person_get_id | ( | const LinphonePresencePerson * | person | ) |
Gets the id of a presence person.
[in] | person | The LinphonePresencePerson object to get the id from. |
The returned string is to be freed by calling ms_free().
unsigned int linphone_presence_person_get_nb_activities | ( | const LinphonePresencePerson * | person | ) |
Gets the number of activities included in the presence person.
[in] | person | The LinphonePresencePerson object to get the number of activities from. |
unsigned int linphone_presence_person_get_nb_activities_notes | ( | const LinphonePresencePerson * | person | ) |
Gets the number of activities notes included in the presence person.
[in] | person | The LinphonePresencePerson object to get the number of activities notes from. |
unsigned int linphone_presence_person_get_nb_notes | ( | const LinphonePresencePerson * | person | ) |
Gets the number of notes included in the presence person.
[in] | person | The LinphonePresencePerson object to get the number of notes from. |
LinphonePresenceNote* linphone_presence_person_get_nth_activities_note | ( | const LinphonePresencePerson * | person, |
unsigned int | idx | ||
) |
Gets the nth activities note of a presence person.
[in] | person | The LinphonePresencePerson object to get the activities note from. |
[in] | idx | The index of the activities note to get (the first note having the index 0). |
LinphonePresenceActivity* linphone_presence_person_get_nth_activity | ( | const LinphonePresencePerson * | person, |
unsigned int | idx | ||
) |
Gets the nth activity of a presence person.
[in] | person | The LinphonePresencePerson object to get the activity from. |
[in] | idx | The index of the activity to get (the first activity having the index 0). |
LinphonePresenceNote* linphone_presence_person_get_nth_note | ( | const LinphonePresencePerson * | person, |
unsigned int | idx | ||
) |
Gets the nth note of a presence person.
[in] | person | The LinphonePresencePerson object to get the note from. |
[in] | idx | The index of the note to get (the first note having the index 0). |
void* linphone_presence_person_get_user_data | ( | const LinphonePresencePerson * | person | ) |
Gets the user data of a LinphonePresencePerson object.
[in] | person | The LinphonePresencePerson object for which to get the user data. |
LinphonePresencePerson* linphone_presence_person_new | ( | const char * | id | ) |
Creates a presence person.
[in] | id | The id of the presence person to be created. Can be NULL to generate it automatically. |
LinphonePresencePerson* linphone_presence_person_ref | ( | LinphonePresencePerson * | person | ) |
Increase the reference count of the LinphonePresencePerson object.
[in] | person | The LinphonePresencePerson object for which the reference count is to be increased. |
int linphone_presence_person_set_id | ( | LinphonePresencePerson * | person, |
const char * | id | ||
) |
Sets the id of a presence person.
[in] | person | The LinphonePresencePerson object for which to set the id. |
[in] | id | The id string to set. Can be NULL to generate it automatically. |
void linphone_presence_person_set_user_data | ( | LinphonePresencePerson * | person, |
void * | user_data | ||
) |
Sets the user data of a LinphonePresencePerson object.
[in] | person | The LinphonePresencePerson object for which to set the user data. |
[in] | user_data | A pointer to the user data to set. |
LinphonePresencePerson* linphone_presence_person_unref | ( | LinphonePresencePerson * | person | ) |
Decrease the reference count of the LinphonePresencePerson object and destroy it if it reaches 0.
[in] | person | The LinphonePresencePerson object for which the reference count is to be decreased. |
int linphone_presence_service_add_note | ( | LinphonePresenceService * | service, |
LinphonePresenceNote * | note | ||
) |
Adds a note to a presence service.
[in] | service | The LinphonePresenceService object for which to add a note. |
[in] | note | The LinphonePresenceNote object to add to the service. |
int linphone_presence_service_clear_notes | ( | LinphonePresenceService * | service | ) |
Clears the notes of a presence service.
[in] | service | The LinphonePresenceService object for which to clear the notes. |
LinphonePresenceBasicStatus linphone_presence_service_get_basic_status | ( | const LinphonePresenceService * | service | ) |
Gets the basic status of a presence service.
[in] | service | The LinphonePresenceService object to get the basic status from. |
char* linphone_presence_service_get_contact | ( | const LinphonePresenceService * | service | ) |
Gets the contact of a presence service.
[in] | service | The LinphonePresenceService object to get the contact from. |
The returned string is to be freed by calling ms_free().
char* linphone_presence_service_get_id | ( | const LinphonePresenceService * | service | ) |
Gets the id of a presence service.
[in] | service | The LinphonePresenceService object to get the id from. |
The returned string is to be freed by calling ms_free().
unsigned int linphone_presence_service_get_nb_notes | ( | const LinphonePresenceService * | service | ) |
Gets the number of notes included in the presence service.
[in] | service | The LinphonePresenceService object to get the number of notes from. |
LinphonePresenceNote* linphone_presence_service_get_nth_note | ( | const LinphonePresenceService * | service, |
unsigned int | idx | ||
) |
Gets the nth note of a presence service.
[in] | service | The LinphonePresenceService object to get the note from. |
[in] | idx | The index of the note to get (the first note having the index 0). |
void* linphone_presence_service_get_user_data | ( | const LinphonePresenceService * | service | ) |
Gets the user data of a LinphonePresenceService object.
[in] | service | The LinphonePresenceService object for which to get the user data. |
LinphonePresenceService* linphone_presence_service_new | ( | const char * | id, |
LinphonePresenceBasicStatus | basic_status, | ||
const char * | contact | ||
) |
Creates a presence service.
[in] | id | The id of the presence service to be created. Can be NULL to generate it automatically. |
[in] | basic_status | The LinphonePresenceBasicStatus to set for the LinphonePresenceService object. |
[in] | contact | The contact string to set. |
The created presence service has the basic status 'closed'.
LinphonePresenceService* linphone_presence_service_ref | ( | LinphonePresenceService * | service | ) |
Increase the reference count of the LinphonePresenceService object.
[in] | service | The LinphonePresenceService object for which the reference count is to be increased. |
int linphone_presence_service_set_basic_status | ( | LinphonePresenceService * | service, |
LinphonePresenceBasicStatus | basic_status | ||
) |
Sets the basic status of a presence service.
[in] | service | The LinphonePresenceService object for which to set the basic status. |
[in] | basic_status | The LinphonePresenceBasicStatus to set for the LinphonePresenceService object. |
int linphone_presence_service_set_contact | ( | LinphonePresenceService * | service, |
const char * | contact | ||
) |
Sets the contact of a presence service.
[in] | service | The LinphonePresenceService object for which to set the contact. |
[in] | contact | The contact string to set. |
int linphone_presence_service_set_id | ( | LinphonePresenceService * | service, |
const char * | id | ||
) |
Sets the id of a presence service.
[in] | service | The LinphonePresenceService object for which to set the id. |
[in] | id | The id string to set. Can be NULL to generate it automatically. |
void linphone_presence_service_set_user_data | ( | LinphonePresenceService * | service, |
void * | user_data | ||
) |
Sets the user data of a LinphonePresenceService object.
[in] | service | The LinphonePresenceService object for which to set the user data. |
[in] | user_data | A pointer to the user data to set. |
LinphonePresenceService* linphone_presence_service_unref | ( | LinphonePresenceService * | service | ) |
Decrease the reference count of the LinphonePresenceService object and destroy it if it reaches 0.
[in] | service | The LinphonePresenceService object for which the reference count is to be decreased. |