add documentation to createLinphoneCore()

This commit is contained in:
Simon Morlat 2014-07-01 23:10:18 +02:00
parent b214e21ffe
commit 823f20b21b

View file

@ -66,7 +66,24 @@ abstract public class LinphoneCoreFactory {
* */
abstract public LinphoneAuthInfo createAuthInfo(String username, String userid, String passwd, String ha1, String realm, String domain);
/**
* Create a LinphoneCore object. The LinphoneCore is the root for all liblinphone operations. You need only one per application.
* @param listener listener to receive notifications from the core
* @param userConfig path where to read/write configuration (optional)
* @param factoryConfig path where to read factory configuration (optional)
* @param userdata any kind of application specific data
* @param context an application context, on android this MUST be the android.content.Context object used by the application.
* @return a LinphoneCore object.
* @throws LinphoneCoreException
*/
abstract public LinphoneCore createLinphoneCore(LinphoneCoreListener listener, String userConfig,String factoryConfig,Object userdata, Object context) throws LinphoneCoreException;
/**
* Create a LinphoneCore object. The LinphoneCore is the root for all liblinphone operations. You need only one per application.
* @param listener listener to receive notifications from the core.
* @param context an application context, on android this MUST be the android.content.Context object used by the application.
* @return the LinphoneCore object.
* @throws LinphoneCoreException
*/
abstract public LinphoneCore createLinphoneCore(LinphoneCoreListener listener, Object context) throws LinphoneCoreException;