org.linphone.core

Interface Ldap

public interface Ldap

Object that represents a Linphone Ldap.

Use a LdapParams object to configure it.

Method Summary

Modifier and Type	Method and Description
Core	getCore() Get the Core object to which is associated the Ldap.
int	getIndex() Get the index of the Ldap.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
LdapParams	getParams() Get the LdapParams as read-only object.
java.lang.Object	getUserData() Gets the object stored in this object user's data
Ldap	newWithParams(Core lc, LdapParams params) Create a new Ldap, associate it with the LdapParams and store it into the configuration file.
void	setIndex(int index) Set the index associated to the Ldap.
void	setParams(LdapParams params) Set the LdapParams used by this Ldap.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getCore

@NonNull
Core getCore()

Get the Core object to which is associated the Ldap.

Returns:

The Core object to which is associated the Ldap.

getIndex

int getIndex()

Get the index of the Ldap.

Returns:

The index of the Ldap

setIndex

void setIndex(int index)

Set the index associated to the Ldap.

getParams

@NonNull
LdapParams getParams()

Get the LdapParams as read-only object.

To make changes, clone the returned object using LdapParams.clone()
method, make your changes on it and apply them using with setParams(org.linphone.core.LdapParams).

Returns:

The LdapParams attached to this ldap.

setParams

void setParams(@NonNull
               LdapParams params)

Set the LdapParams used by this Ldap.

The parameters will be saved in the configuration file.

Parameters:

params - The LdapParams object.

newWithParams

@NonNull
Ldap newWithParams(@NonNull
                            Core lc,
                            @NonNull
                            LdapParams params)

Create a new Ldap, associate it with the LdapParams and store
it into the configuration file.

Parameters:

lc - The Core object.

params - The LdapParams object.

Returns:

The newly created Ldap object.

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