Package org.linphone.core

Interface ConferenceInfo

public interface ConferenceInfo

Object defining all information related to a conference.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConferenceInfo.State

Method Summary

Modifier and Type	Method	Description
void	addParticipant(Address participant)	Add a participant to the conference.
ConferenceInfo	clone()	Clone an object ConferenceInfo.
long	getDateTime()	Retrieve the date and time of the conference.
java.lang.String	getDescription()	Retrieve the description of the conference.
int	getDuration()	Retrieve the duration (in minutes) of the conference.
java.lang.String	getIcalendarString()	Retrieve the conference as an Icalendar string.
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
Address	getOrganizer()	Retrieve the organizer of the conference.
Address[]	getParticipants()	Retrieve the list of participants.
ConferenceInfo.State	getState()	Retrieve the state of the conference info.
java.lang.String	getSubject()	Retrieve the subject of the conference.
Address	getUri()	Retrieve the URI of the conference.
java.lang.Object	getUserData()	Gets the object stored in this object user's data
void	removeParticipant(Address participant)	Remove a participant from the conference.
void	setDateTime(long datetime)	Set the date and time of the conference.
void	setDescription(java.lang.String description)	Set the description of the conference.
void	setDuration(int duration)	Set the duration (in minutes) of the conference.
void	setOrganizer(Address organizer)	Set the organizer of the conference.
void	setParticipants(Address[] participants)	Set the list of participants.
void	setSubject(java.lang.String subject)	Set the subject of the conference.
void	setUserData(java.lang.Object data)	Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getDateTime

long getDateTime()

Retrieve the date and time of the conference.

Returns:

The date and time of the conference.

setDateTime

void setDateTime(long datetime)

Set the date and time of the conference.

Parameters:

datetime - The date and time of the conference.

getDescription

@Nullable
java.lang.String getDescription()

Retrieve the description of the conference.

Returns:

The description of the conference.

setDescription

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

Set the description of the conference.

Parameters:

description - The description of the conference.

getDuration

int getDuration()

Retrieve the duration (in minutes) of the conference.

Returns:

The duration of the conference.

setDuration

void setDuration(int duration)

Set the duration (in minutes) of the conference.

Parameters:

duration - The duration of the conference.

getIcalendarString

@Nullable
java.lang.String getIcalendarString()

Retrieve the conference as an Icalendar string.

Returns:

The conference as an Icalendar string. The returned char* must be freed
by the caller.

getOrganizer

@Nullable
Address getOrganizer()

Retrieve the organizer of the conference.

Returns:

The Address of the conference's organizer.

setOrganizer

void setOrganizer(@Nullable
                  Address organizer)

Set the organizer of the conference.

Parameters:

organizer - The Address of the conference's organizer.

getParticipants

@NonNull
Address[] getParticipants()

Retrieve the list of participants.

Returns:

The list of participants.

setParticipants

void setParticipants(@Nullable
                     Address[] participants)

Set the list of participants.

Parameters:

participants - The list of participants to set.

getState

@Nullable
ConferenceInfo.State getState()

Retrieve the state of the conference info.

Returns:

ConferenceInfo.State object.

getSubject

@Nullable
java.lang.String getSubject()

Retrieve the subject of the conference.

Returns:

The subject of the conference.

setSubject

void setSubject(@Nullable
                java.lang.String subject)

Set the subject of the conference.

Parameters:

subject - The subject of the conference.

getUri

@Nullable
Address getUri()

Retrieve the URI of the conference.

Returns:

The URI of the conference (Address).

addParticipant

void addParticipant(@NonNull
                    Address participant)

Add a participant to the conference.

Parameters:

participant - The participant (Address) to add.

clone

@NonNull
ConferenceInfo clone()

Clone an object ConferenceInfo.

Returns:

the cloned ConferenceInfo object.

removeParticipant

void removeParticipant(@NonNull
                       Address participant)

Remove a participant from the conference.

Parameters:

participant - The participant (Address) to remove.

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

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object