PresenceModel

```
public interface PresenceModel
```

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`addActivity(PresenceActivity activity)` Adds an activity to a presence model.
`int`	`addNote(String note_content, String lang)` Adds a note to a presence model.
`int`	`addPerson(PresencePerson person)` Adds a person to a presence model.
`int`	`addService(PresenceService service)` Adds a service to a presence model.
`int`	`clearActivities()` Clears the activities of a presence model.
`int`	`clearNotes()` Clears all the notes of a presence model.
`int`	`clearPersons()` Clears the persons of a presence model.
`int`	`clearServices()` Clears the services of a presence model.
`PresenceActivity`	`getActivity()` Gets the first activity of a presence model (there is usually only one).
`PresenceBasicStatus`	`getBasicStatus()` Gets the basic status of a presence model.
`String`	`getContact()` Gets the contact of a presence model.
`long`	`getNbActivities()` Gets the number of activities included in the presence model.
`long`	`getNbPersons()` Gets the number of persons included in the presence model.
`long`	`getNbServices()` Gets the number of services included in the presence model.
`PresenceNote`	`getNote(String lang)` Gets the first note of a presence model (there is usually only one).
`PresenceActivity`	`getNthActivity(long idx)` Gets the nth activity of a presence model.
`PresencePerson`	`getNthPerson(long idx)` Gets the nth person of a presence model.
`PresenceService`	`getNthService(long idx)` Gets the nth service of a presence model.
`long`	`getTimestamp()` Gets the timestamp of a presence model.
`int`	`setActivity(PresenceActivityType activity, String description)` Sets the activity of a presence model (limits to only one activity).
`int`	`setBasicStatus(PresenceBasicStatus basic_status)` Sets the basic status of a presence model.
`void`	`setContact(String contact)` Sets the contact of a presence model.

- Method Detail
  - getBasicStatus
```
PresenceBasicStatus getBasicStatus()
```
    Gets the basic status of a presence model.
    
    Returns:
    The #BasicStatus of the #PresenceModel object.
  - setBasicStatus
```
int setBasicStatus(PresenceBasicStatus basic_status)
```
    Sets the basic status of a presence model.
    
    Parameters:
    basic_status - The #BasicStatus to set for the #PresenceModel object.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - getTimestamp
```
long getTimestamp()
```
    Gets the timestamp of a presence model.
    
    Returns:
    The timestamp of the #LinphonePresenceModel object or -1 on error.
  - getContact
```
String getContact()
```
    Gets the contact of a presence model.
    
    Returns:
    A string containing the contact, or null if no contact is found.
  - setContact
```
void setContact(String contact)
```
    Sets the contact of a presence model.
    
    Parameters:
    contact - The contact string to set.
  - getActivity
```
PresenceActivity getActivity()
```
    Gets the first activity of a presence model (there is usually only one).
    
    Returns:
    A #PresenceActivity object if successful, null otherwise.
  - setActivity
```
int setActivity(PresenceActivityType activity,
              String description)
```
    Sets the activity of a presence model (limits to only one activity).
    
    Parameters:
    activity - The #PresenceActivityType to set for the model.
    description - An additional description of the activity to set for the model. Can be null if no additional description is to be added.
    
    Returns:
    0 if successful, a value < 0 in case of error. WARNING: This method 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 setBasicStatus(), clearActivities() and addActivity().
  - getNbActivities
```
long getNbActivities()
```
    Gets the number of activities included in the presence model.
    
    Returns:
    The number of activities included in the #PresenceModel object.
  - getNthActivity
```
PresenceActivity getNthActivity(long idx)
```
    Gets the nth activity of a presence model.
    
    Parameters:
    idx - The index of the activity to get (the first activity having the index 0).
    
    Returns:
    A #PresenceActivity object if successful, null otherwise.
  - addActivity
```
int addActivity(PresenceActivity activity)
```
    Adds an activity to a presence model.
    
    Parameters:
    activity - The #PresenceActivity to add to the model.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - clearActivities
```
int clearActivities()
```
    Clears the activities of a presence model.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - getNote
```
PresenceNote getNote(String lang)
```
    Gets the first note of a presence model (there is usually only one).
    
    Parameters:
    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.
    
    Returns:
    A #PresenceNote object if successful, null otherwise.
  - addNote
```
int addNote(String note_content,
          String lang)
```
    Adds a note to a presence model.
    
    Parameters:
    note_content - The note to be added to the presence model.
    lang - The language of the note to be added. Can be null if no language is to be specified for the note.
    
    Returns:
    0 if successful, a value < 0 in case of error. Only one note for each language can be set, so e.g. setting a note for the 'fr' language if there is only one will replace the existing one.
  - clearNotes
```
int clearNotes()
```
    Clears all the notes of a presence model.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - getNbServices
```
long getNbServices()
```
    Gets the number of services included in the presence model.
    
    Returns:
    The number of services included in the #PresenceModel object.
  - getNthService
```
PresenceService getNthService(long idx)
```
    Gets the nth service of a presence model.
    
    Parameters:
    idx - The index of the service to get (the first service having the index 0).
    
    Returns:
    A #PresenceService object if successful, null otherwise.
  - addService
```
int addService(PresenceService service)
```
    Adds a service to a presence model.
    
    Parameters:
    service - The #PresenceService object to add to the model.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - clearServices
```
int clearServices()
```
    Clears the services of a presence model.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - getNbPersons
```
long getNbPersons()
```
    Gets the number of persons included in the presence model.
    
    Returns:
    The number of persons included in the #PresenceModel object.
  - getNthPerson
```
PresencePerson getNthPerson(long idx)
```
    Gets the nth person of a presence model.
    
    Parameters:
    idx - The index of the person to get (the first person having the index 0).
    
    Returns:
    A pointer to a #PresencePerson object if successful, null otherwise.
  - addPerson
```
int addPerson(PresencePerson person)
```
    Adds a person to a presence model.
    
    Parameters:
    person - The #PresencePerson object to add to the model.
    
    Returns:
    0 if successful, a value < 0 in case of error.
  - clearPersons
```
int clearPersons()
```
    Clears the persons of a presence model.
    
    Returns:
    0 if successful, a value < 0 in case of error.

Interface PresenceModel

Method Summary

Method Detail

getBasicStatus

setBasicStatus

getTimestamp

getContact

setContact

getActivity

setActivity

getNbActivities

getNthActivity

addActivity

clearActivities

getNote

addNote

clearNotes

getNbServices

getNthService

addService

clearServices

getNbPersons

getNthPerson

addPerson

clearPersons