Create User / Login

TalkPlus supports anonymous and token-based login. In order to use token-based login, you must call /api/users/create and /api/users/login from our REST API endpoints to create user and retrieve user’s login token.

If you need translation feature, see below.

Message translation feature is provided through Google Cloud Translation. To use this feature, register an appropriate Google Cloud Service Account Key on our dashboard.

• To enable message translation, provide the language code (ISO-639) in translationLanguage property of TPLoginParams object when logging in.

• Supported languages (ISO-639) can be found here.

• Calling 'getTranslatedText' on TPMessage object will return a Key-Value map. Translated text(value) can be accessed from the map by using language code (used in 'translationLanguages' parameter) as key.

• Translation feature is available starting from TalkPlus Flutter SDK v0.5.3.

1. Anonymous User

You need a unique user ID and a username to login anonymously.

You need to allow Anonymous User login option under App Settings in the dashboard before use.

If translationLanguage property in TPLoginParams is set, TPMessage object received via "onMessageReceived" callback event will contain translated text for that language.

• Setting the translation language here enables realtime messages handled via callback events to be translated.

• TPLoginParams class is available starting from TalkPlus Flutter SDK v0.5.3.

You can enter up to 5 key-value pairs in data field. The maximum size of key is 128 characters and the maximum size of value is 1024 characters. Both key and value must be strings.

Profile image URL provided by user

final loginParams = 
    TPLoginParams(loginType: TPLoginType.TPLoginAnonymous, userId: userId)
..userName = userName
..profileImageUrl = profileImageUrl
..translationLanguage = translationLanguage;
    
TPUser? user = await TalkPlusAPI.login(loginParams,
    errorCallback: (errorCode, errorMessage){    
    }
);

Upload profile image file

final loginParams = 
    TPLoginParams(loginType: TPLoginType.TPLoginAnonymous, userId: userId)
..userName = userName
..profileImage = profileImage
..translationLanguage = translationLanguage;

TPUser? user = await TalkPlusAPI.login(loginParams,
    errorCallback: (errorCode, errorMessage){    
    }
);

2. Token User

You need a unique user ID, a username and a login token to login.

You need to call /api/users/create and /api/users/login from our REST API endpoints to obtain login token.

If translationLanguage property in TPLoginParams is set, TPMessage object received via "onMessageReceived" callback event will contain translated text for that language.

• Setting the translation language here enables realtime messages handled via callback events to be translated.

• TPLoginParams class is available starting from TalkPlus Flutter SDK v0.5.3.

You can enter up to 5 key-value pairs in data field. The maximum size of key is 128 characters and the maximum size of value is 1024 characters. Both key and value must be strings.

Profile image URL provided by user

final loginParams = 
    TPLoginParams(loginType: TPLoginType.TPLoginToken, userId: userId)
..loginToken = loginToken
..userName = userName
..profileImageUrl = profileImageUrl
..translationLanguage = translationLanguage;

TPUser? user = await TalkPlusAPI.login(loginParams,
    errorCallback: (errorCode, errorMessage){    
    }
);

Upload profile image file

final loginParams = 
    TPLoginParams(loginType: TPLoginType.TPLoginToken, userId: userId)
..loginToken = loginToken
..userName = userName
..profileImage = profileImage
..translationLanguage = translationLanguage;

TPUser? user = await TalkPlusAPI.login(loginParams,
    errorCallback: (errorCode, errorMessage){    
    }
);