org.linphone.core

Interface PresenceService

public interface PresenceService

Method Summary

Methods

Modifier and Type	Method and Description
int	addNote(PresenceNote note) Adds a note to a presence service.
int	clearNotes() Clears the notes of a presence service.
PresenceBasicStatus	getBasicStatus() Gets the basic status of a presence service.
String	getContact() Gets the contact of a presence service.
String	getId() Gets the id of a presence service.
long	getNativePtr() Gets the native pointer for this object.
long	getNbNotes() Gets the number of notes included in the presence service.
PresenceNote	getNthNote(long idx) Gets the nth note of a presence service.
int	setBasicStatus(PresenceBasicStatus status) Sets the basic status of a presence service.
int	setContact(String contact) Sets the contact of a presence service.
int	setId(String id) Sets the id of a presence service.

Method Detail

getId

String getId()

Gets the id of a presence service.

Returns:

A string containing the id.

setId

int setId(String id)

Sets the id of a presence service.

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.

getBasicStatus

PresenceBasicStatus getBasicStatus()

Gets the basic status of a presence service.

Returns:

The #PresenceBasicStatus of the #PresenceService object.

setBasicStatus

int setBasicStatus(PresenceBasicStatus status)

Sets the basic status of a presence service.

Parameters:

status - The #PresenceBasicStatus to set for the #PresenceService object.

Returns:

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

getContact

String getContact()

Gets the contact of a presence service.

Returns:

A string containing the contact, or null if no contact is found.

setContact

int setContact(String contact)

Sets the contact of a presence service.

Parameters:

contact - The contact string to set.

Returns:

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

getNbNotes

long getNbNotes()

Gets the number of notes included in the presence service.

Returns:

The number of notes included in the #PresenceService object.

getNthNote

PresenceNote getNthNote(long idx)

Gets the nth note of a presence service.

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

Parameters:

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

Returns:

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

clearNotes

int clearNotes()

Clears the notes of a presence service.

Returns:

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

getNativePtr

long getNativePtr()

Gets the native pointer for this object.