liblinphone
3.8.0
|
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_friend_new_with_addr("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
Contructor same as linphone_friend_new() + linphone_friend_set_address()
Set LinphoneAddress for this friend
typedef enum _LinphoneSubscribePolicy LinphoneSubscribePolicy |
Enum controlling behavior for incoming subscription request.
Use by linphone_friend_set_inc_subscribe_policy()
typedef enum _LinphoneOnlineStatus LinphoneOnlineStatus |
Enum describing remote friend status
typedef struct _LinphoneFriend LinphoneFriend |
Represents a buddy, all presence actions like subscription and status change notification are performed on this object
typedef enum LinphonePresenceBasicStatus LinphonePresenceBasicStatus |
Basic status as defined in section 4.1.4 of RFC 3863
typedef enum LinphonePresenceActivityType LinphonePresenceActivityType |
Activities as defined in section 3.2 of RFC 4480
typedef struct _LinphonePresenceModel LinphonePresenceModel |
Presence model type holding information about the presence of a person.
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 struct _LinphonePresenceActivity LinphonePresenceActivity |
Presence activity type holding information about a presence activity.
typedef struct _LinphonePresenceNote LinphonePresenceNote |
Presence note type holding information about a presence note.
Enum controlling behavior for incoming subscription request.
Use by linphone_friend_set_inc_subscribe_policy()
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. |
Enum describing remote friend status
LinphoneStatusOffline |
Offline |
LinphoneStatusOnline |
Online |
LinphoneStatusBusy |
Busy |
LinphoneStatusBeRightBack |
Be right back |
LinphoneStatusAway |
Away |
LinphoneStatusOnThePhone |
On the phone |
LinphoneStatusOutToLunch |
Out to lunch |
LinphoneStatusDoNotDisturb |
Do not disturb |
LinphoneStatusMoved |
Moved in this sate, call can be redirected if an alternate contact address has been set using function linphone_core_set_presence_info() |
LinphoneStatusAltService |
Using another messaging service |
LinphoneStatusPending |
Pending |
LinphoneStatusVacation |
Vacation |
Basic status as defined in section 4.1.4 of RFC 3863
Activities as defined in section 3.2 of RFC 4480
LinphoneFriend* linphone_friend_new | ( | void | ) |
Contructor
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@sip.linphone.org |
void linphone_friend_destroy | ( | LinphoneFriend * | lf | ) |
Destructor
lf | LinphoneFriend object |
int linphone_friend_set_address | ( | LinphoneFriend * | fr, |
const LinphoneAddress * | address | ||
) |
Set LinphoneAddress for this friend
fr | LinphoneFriend object |
address | LinphoneAddress |
const LinphoneAddress* linphone_friend_get_address | ( | const LinphoneFriend * | lf | ) |
int linphone_friend_set_name | ( | LinphoneFriend * | lf, |
const char * | name | ||
) |
Set the display name for this friend
lf | LinphoneFriend object |
name |
const char* linphone_friend_get_name | ( | const LinphoneFriend * | lf | ) |
Get the display name for this friend
lf | LinphoneFriend object |
bool_t linphone_friend_subscribes_enabled | ( | const LinphoneFriend * | lf | ) |
get subscription flag value
lf | LinphoneFriend object |
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 |
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. |
get current subscription policy for this LinphoneFriend
lf | 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.
void linphone_friend_done | ( | LinphoneFriend * | fr | ) |
Commits modification made to the friend configuration.
fr | LinphoneFriend object |
LinphoneOnlineStatus linphone_friend_get_status | ( | const LinphoneFriend * | lf | ) |
Get the status of a friend
[in] | lf | A LinphoneFriend object |
Get the presence model of a friend
[in] | lf | A LinphoneFriend object |
void linphone_friend_set_user_data | ( | LinphoneFriend * | lf, |
void * | data | ||
) |
Store user pointer to friend object.
void* linphone_friend_get_user_data | ( | const LinphoneFriend * | lf | ) |
Retrieve user data associated with friend.
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. |
const char* linphone_friend_get_ref_key | ( | const LinphoneFriend * | lf | ) |
Get the reference key of a friend.
[in] | lf | 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. |
const char* linphone_online_status_to_string | ( | LinphoneOnlineStatus | ss | ) |
Return humain readable presence status
ss |
Create a default LinphoneFriend.
[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 |
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 |
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_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_remove_friend | ( | LinphoneCore * | lc, |
LinphoneFriend * | fr | ||
) |
remove a friend from the buddy list
lc | LinphoneCore object |
fr | LinphoneFriend to add |
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 |
const MSList* linphone_core_get_friend_list | ( | const LinphoneCore * | lc | ) |
Get Buddy list of LinphoneFriend
[in] | lc | LinphoneCore object |
void linphone_core_notify_all_friends | ( | LinphoneCore * | lc, |
LinphonePresenceModel * | presence | ||
) |
Notify all friends that have subscribed
lc | LinphoneCore object |
presence | LinphonePresenceModel to notify |
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_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. |
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. |
LinphoneCore* linphone_friend_get_core | ( | const LinphoneFriend * | fr | ) |
Returns the LinphoneCore object managing this friend, if any.
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.
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. |
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. |
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. |
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().
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. |
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. |
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().
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. |
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). |
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_clear_activities | ( | LinphonePresenceModel * | model | ) |
Clears the activities of a presence model.
[in] | model | The LinphonePresenceModel object for which to clear the activities. |
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. |
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_clear_notes | ( | LinphonePresenceModel * | model | ) |
Clears all the notes of a presence model.
[in] | model | The LinphonePresenceModel for which to clear notes. |
Creates a default presence model.
The created presence model is considered 'offline'.
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. |
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). |
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_services | ( | LinphonePresenceModel * | model | ) |
Clears the services of a presence model.
[in] | model | The LinphonePresenceModel object for which to clear the services. |
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. |
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). |
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_clear_persons | ( | LinphonePresenceModel * | model | ) |
Clears the persons of a presence model.
[in] | model | The LinphonePresenceModel object for which to clear the persons. |
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'.
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().
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. |
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. |
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. |
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().
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. |
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). |
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. |
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. |
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().
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. |
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. |
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). |
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_clear_activities | ( | LinphonePresencePerson * | person | ) |
Clears the activities of a presence person.
[in] | person | The LinphonePresencePerson object for which to clear the activities. |
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_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). |
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_notes | ( | LinphonePresencePerson * | person | ) |
Clears the notes of a presence person.
[in] | person | The LinphonePresencePerson object for which to clear the notes. |
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. |
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). |
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. |
Clears the activities notes of a presence person.
[in] | person | The LinphonePresencePerson object for which to clear the activities notes. |
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. |
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().
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Increase the reference count of the LinphonePresenceModel object.
[in] | model | The LinphonePresenceModel object for which the reference count is to be increased. |
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. |
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. |
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. |
Increase the reference count of the LinphonePresenceService object.
[in] | service | The LinphonePresenceService object for which the reference count is to be increased. |
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. |
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. |
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. |
Increase the reference count of the LinphonePresencePerson object.
[in] | person | The LinphonePresencePerson object for which the reference count is to be increased. |
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. |
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. |
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. |
Increase the reference count of the LinphonePresenceActivity object.
[in] | activity | The LinphonePresenceActivity object for which the reference count is to be increased. |
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. |
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. |
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. |
Increase the reference count of the LinphonePresenceNote object.
[in] | note | The LinphonePresenceNote object for which the reference count is to be increased. |
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. |
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. |
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. |
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. |
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. |