org.linphone.core

Interface PresencePerson

public interface PresencePerson

Method Summary

Methods

Modifier and Type	Method and Description
int	addActivitiesNote(PresenceNote note) Adds an activities note to a presence person.
int	addActivity(PresenceActivity activity) Adds an activity to a presence person.
int	addNote(PresenceNote note) Adds a note to a presence person.
int	clearActivitesNotes() Clears the activities notes of a presence person.
int	clearActivities() Clears the activities of a presence person.
int	clearNotes() Clears the notes of a presence person.
String	getId() Gets the id of a presence person.
long	getNativePtr() Gets the native pointer for this object.
long	getNbActivities() Gets the number of activities included in the presence person.
long	getNbActivitiesNotes() Gets the number of activities notes included in the presence person.
long	getNbNotes() Gets the number of notes included in the presence person.
PresenceNote	getNthActivitiesNote(long idx) Gets the nth activities note of a presence person.
PresenceActivity	getNthActivity(long idx) Gets the nth activity of a presence person.
PresenceNote	getNthNote(long idx) Gets the nth note of a presence person.
int	setId(String id) Sets the id of a presence person.

Method Detail

getId

String getId()

Gets the id of a presence person.

Returns:

A string containing the id.

setId

int setId(String id)

Sets the id of a presence person.

Parameters:

id - The id string to set. Can be null to generate it automatically.

Returns:

0 if successful, a value < 0 in case of error.

getNbActivities

long getNbActivities()

Gets the number of activities included in the presence person.

Returns:

The number of activities included in the #PresencePerson object.

getNthActivity

PresenceActivity getNthActivity(long idx)

Gets the nth activity of a presence person.

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 person.

Parameters:

activity - The #PresenceActivity object to add to the person.

Returns:

0 if successful, a value < 0 in case of error.

clearActivities

int clearActivities()

Clears the activities of a presence person.

Returns:

0 if successful, a value < 0 in case of error.

getNbNotes

long getNbNotes()

Gets the number of notes included in the presence person.

Returns:

The number of notes included in the #PresencePerson object.

getNthNote

PresenceNote getNthNote(long idx)

Gets the nth note of a presence person.

Parameters:

idx - The index of the note to get (the first note having the index 0).

Returns:

A pointer to a #PresenceNote object if successful, null otherwise.

addNote

int addNote(PresenceNote note)

Adds a note to a presence person.

Parameters:

note - The #PresenceNote object to add to the person.

Returns:

0 if successful, a value < 0 in case of error.

clearNotes

int clearNotes()

Clears the notes of a presence person.

Returns:

0 if successful, a value < 0 in case of error.

getNbActivitiesNotes

long getNbActivitiesNotes()

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

Returns:

The number of activities notes included in the #PresencePerson object.

getNthActivitiesNote

PresenceNote getNthActivitiesNote(long idx)

Gets the nth activities note of a presence person.

Parameters:

idx - The index of the activities note to get (the first note having the index 0).

Returns:

A pointer to a #PresenceNote object if successful, null otherwise.

addActivitiesNote

int addActivitiesNote(PresenceNote note)

Adds an activities note to a presence person.

Parameters:

note - The #PresenceNote object to add to the person.

Returns:

0 if successful, a value < 0 in case of error.

clearActivitesNotes

int clearActivitesNotes()

Clears the activities notes of a presence person.

Returns:

0 if successful, a value < 0 in case of error.

getNativePtr

long getNativePtr()

Gets the native pointer for this object.