org.linphone.core

Interface PresenceActivity

public interface PresenceActivity

Presence activity type holding information about a presence activity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PresenceActivity.Type

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description of a presence activity.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
PresenceActivity.Type	getType() Gets the activity type of a presence activity.
java.lang.Object	getUserData() Gets the object stored in this object user's data
int	setDescription(java.lang.String description) Sets the description of a presence activity.
int	setType(PresenceActivity.Type acttype) Sets the type of activity of a presence activity.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
java.lang.String	toString() Gets the string representation of a presence activity.

Method Detail

getDescription

@Nullable
java.lang.String getDescription()

Gets the description of a presence activity.

Returns:

A pointer to the description string of the presence activity, or null
if no description is specified.

setDescription

int setDescription(@Nullable
                   java.lang.String description)

Sets the description of a presence activity.

Parameters:

description - An additional description of the activity. Can be null if no
additional description is to be added.

Returns:

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

getType

PresenceActivity.Type getType()

Gets the activity type of a presence activity.

Returns:

The PresenceActivity.Type of the activity.

setType

int setType(PresenceActivity.Type acttype)

Sets the type of activity of a presence activity.

Parameters:

acttype - The PresenceActivity.Type to set for the activity.

Returns:

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

toString

@NonNull
java.lang.String toString()

Gets the string representation of a presence activity.

Overrides:

toString in class java.lang.Object

Returns:

A pointer a dynamically allocated string representing the given
activity.
The returned string is to be freed by calling ms_free().

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long