Profile module

Profile related methods are described here.

Register

To register a new user use the below method.

If autoLogin is true, after successful registration, the user will be logged in with XMPP.

Note: If the sandbox mode is set to true in the initialization, users will be registered in the sandbox mode

await SDK.register(`USER_IDENTIFIER`, `AUTO_LOGIN`);

Request Params

Status	Description	Type	Required
USER_IDENTIFIER	Unique Id to Register the User	String	true
AUTO_LOGIN	Auto Login after Registration	Boolean	false

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Username and Password	Object

Sample Response:

If autoLogin is true

{

statusCode: 200,

message: "Login Success"

}

If autoLogin is false

{

statusCode: 200,

message: "Success",

data: {

username: "123456789",

password: "987654321"

}

}

Login with Username

Make a connection by login into the XMPP server using the credentials. Once the connection is made successfully, it returns a Promise with statusCode of 200, else throws an Error.

This will also emit the connection status. It will be received in connectionListener callback function. If any error occurs while making a connection with the server, You will receive the error in the callback.

await SDK.login(`USERNAME`, `PASSWORD`);

Request Params

Status	Description	Type	Required
USERNAME	Username	String	true
PASSWORD	Password	String	true

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String

Login with QR Code

If login needs to be done via QR Code scan from Mobile, generate new QR Code with below method.

Once the QR Code scanned successfully, the user will be with XMPP, and username and password will be received in callback response

await SDK.generateQrCode(`DOM_ELEMENT_ID`, `LOGO_ELEMENT_ID`, `SIGNAL_SERVER_URL`, () => {

// Handle Callback Here

});

Request Params

Status	Description	Type	Required
DOM_ELEMENT_ID	Canvas element id in which QR Code has to appended	String	true
LOGO_ELEMENT_ID	Branding Logo in the QR Code	String	true
SIGNAL_SERVER_URL	Signal Server URL for Socket Connection	String	true

Example Request

SDK.generateQrCode(

document.getElementById("canvas"),

document.getElementById("logo"),

"wss://domain.com",

(response) => {

// Handle Response

}

);

Logout

To disconnect the XMPP connection, use the below method.

await SDK.logout();

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String

Get Friends List

To get the friends list, send a request as described below.

await SDK.getFriendsList();

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Array of Users Object	Array

Check here for response format

Note: friendsListListener also will be triggered with the same response.

Get User Profile Detail

To get the Profile detail of the user, send a request as described below.

await SDK.getUserProfile(`TO_USER_JID`);

Request Param

Status	Description	Type	Required
TO_USER_JID	JID of the To User	JID String	true

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Profile Details Object	Object

Check here for response format.

Note: userprofilelistener also will be triggered with the same response.

Update User Profile Detail

To set the Profile detail of the user, send a request as described below.

Once the request is successfully made, a callback userProfileListener will be triggered for the current user and also for the friends (Contacts of the current user) to get the latest profile details.

await SDK.setUserProfile(`NAME`, `IMAGE`, `STATUS`, `MOBILE_NUMBER`, `EMAIL`);

Request Params

Status	Description	Type	Required
NAME	Nickname of the User	String	true
IMAGE	Profile Image - Upload an image file or image URL	File / String	true
STATUS	Profile Status	String	true
MOBILE_NUMBER	Mobile Number	String	true
EMAIL	Email Address	String	true

Example Request

Image as a URL

await SDK.setUserProfile(

"Name",

"https://domain/path/image.png",

"status",

"1111111111",

"email@domain",

);

Image as a FILE

await SDK.setUserProfile("Name", FILE, "status", "1111111111", "email@domain");

Get User's Last Seen Time

To get the user's last seen, send a request as described below.

await SDK.getLastSeen(`TO_USER_JID`);

Request Param

Status	Description	Type	Required
TO_USER_JID	JID of the To User	JID String	true

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Last Seen Details Object	Object

Check here for response format.

Block User

Block User method uses to block the User from sending a message to us, it also hides our information from them. Use the below method by passing the JID of the user whom we are blocking.

await SDK.blockUser(`TO_USER_JID`);

Request Param

Status	Description	Type	Required
TO_USER_JID	JID of the To User	JID String	true

Unblock User

To unblock the User use the below method.

await SDK.unblockUser(`TO_USER_JID`);

Request Param

Status	Description	Type	Required
TO_USER_JID	JID of the To User	JID String	true

Get Users I Blocked

To get the list of Users whom we blocked, send a request as described below.

await SDK.getUsersIBlocked();

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Blocked User List	Array

Check here for response format.

Get Users Who Blocked Me

To get the list of Users who blocked Us, send a request as described below.

await SDK.getUsersWhoBlockedMe();

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
data	Blocked User List	Array

Check here for response format.

Get Current User Jid

To get the Jid of the logged in user.

await SDK.getCurrentUserJid();

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
userJid	JID of the User	JID String

Get User Token

Generates and retrives new usertoken to access the API.

await SDK.getUserToken(`USERNAME`, `PASSWORD`);

Request Params

Status	Description	Type	Required
USERNAME	Username	String	true
PASSWORD	Password	String	true

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String
userToken	User Token	String

Set User Token

To set the user token locally.

await SDK.setUserToken(`TOKEN`);

Request Params

Status	Description	Type	Required
TOKEN	User Token	String	true

Response Params

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String