Profile module

Get User profile data#

To get the profile data of a user(not a group) call the below method.

Flutter

FlyChat.getUserProfile(USER_JID,[FETCH_FROM_SERVER,SAVE_AS_FRIEND]).then((value) {
   var data = profileDataFromJson(value);

}).catchError((onError) {
   /* Error handling */
});

Refer this doc to know more about Profile Class

Argument	Type	Description
USER_JID	`String`	Jid of the user
FETCH_FROM_SERVER	`boolean`	true to fetch from server
SAVE_AS_FRIEND	`boolean`	if true the user will be saved as friend and will be available in contact list

Update User profile#

To update your profile call the below method.

FlyChat.updateMyProfile(PROFILE_NAME,PROFILE_EMAIL,PROFILE_MOBILE,PROFILE_STATUS,IMG_URL).then((value) {
var data = profileUpdateFromJson(value);

   /* Profile image updated. Update the UI */
 }).catchError((error) {
   /* Error handling */
 });

info

In profile object for image property set the absolute file path of a file if a image file needs to be uploaded or else set it to profile image id.

Refer this doc to know more about Profile Class

Argument	Description	Data type
`PROFILE_OBJECT`	`Profile`	`Profile` object which the updated value

Update profile image#

To update your profile image call the below method.

FlyChat.updateMyProfileImage(PROFILE_IMAGE_FILE).then((value) {
   var data = json.decode(value);
   //Profile image Updated. Update the UI
}).catchError((onError) {
   /* Error handling */
});

Argument	Type	Description
PROFILE_IMAGE_FILE	`String`	file of the profile image

Refer Profile to know more about Profile class.

Remove profile image#

To remove your profile image call the below method.

FlyChat.removeProfileImage().then((bool? value) {
   if (value!=null){
      //Profile image removed. Update the UI
   }
}).catchError((onError) {
   //Removing profile image failed print throwable to find the exception details
});

All the contact related operation will be found below.#

Block a User#

To block a user call the below method.

FlyChat.blockUser(JID_TO_BLOCK).then((bool? value) {
   if (value!=null){
      //Update the UI
   }
}).catchError((onError) {
   
});

Argument	Type	Description
JID_TO_BLOCK	`String`	`JID` of the user

Unblock a User#

To unblock a user who is blocked already call the below method.

FlyChat.unblockUser(JID_TO_UNBLOCK).then((bool? value) {
   if (value!=null){
      //Update the UI
   }
}).catchError((onError) {
 
});

Argument	Type	Description
JID_TO_UNBLOCK	`String`	`JID` of the user

caution

Blocking and Unblocking valid for Single chat user only not for Group/Broadcast.

Get user profiles that you blocked#

To get the list of chat user profiles that you blocked call the below method.

FlyChat.getUsersIBlocked(SERVER_CALL).then((value) {
   if (value!=null){
    var list = memberFromJson(value);
      Update the UI
   }
}).catchError((onError) {
   
});

Argument	Description	Type
SERVER_CALL	`boolean`	`true` to get the synced list from server `false` to get the list from local data. default value is `false`

Note : To make server call internet connection is required

Get user profiles that blocked you#

To get the list of single chat user that blocked you call the below method.

FlyChat.getUsersWhoBlockedMe(SERVER_CALL).then((value){
  // Status Set
}).catchError((er){
   // Error handling
});

Argument	Type	Description
SERVER_CALL	`boolean`	`true` to get the synced list from server `false` to get the list from local data. default value is `false`

Note : To make server call internet connection is required

Get Unknown single chat Profiles#

To get the list of single chat user those are not in your contacts if you use phone number as your primary way of communication .

FlyChat.getUnKnownUserProfiles().then((value){
  // Update UI
}).catchError((er){
   // Error handling
});

Get current User status#

User can get their current user status using the below method.

FlyChat.getMyProfileStatus().then((value){
  // Update UI
}).catchError((er){
   // Error handling
});

Refer this doc to know more about ProfileStatus Class

Get current User busy status#

User can get their current user busy status using the below method.

FlyChat.getMyBusyStatus().then((value){
   // Update UI
}).catchError((er){
   // Error handling
});

Refer this doc to know more about BusyStatus Class

Set User status#

User can set the status for their profile using the below method.

FlyChat.setMyProfileStatus(STATUS_TEXT).then((value){
   // Status Set
}).catchError((er){
   // Error handling
});

Argument	Type	Description
STATUS_TEXT	`String`	Status text cannot be longer than 140 characters

Set User Busy status#

User can set the busy status message for their one to one chat conversation using the below method.

FlyChat.setMyBusyStatus(BUSY_STATUS_TEXT).then((bool? value){

}).catchError((er){
   // Error handling
});

Argument	Type	Description
BUSY_STATUS_TEXT	`String`	busy status text cannot be longer than 140 characters

Enable/Disable User Busy status#

User can enable and disable their busy status using the below method.

FlyChat.enableDisableBusyStatus(ENABLE_BUSY_STATUS).then((bool? value){

}).catchError((er){
   // Error handling
});

Argument	Type	Description
ENABLE_BUSY_STATUS	`boolean`	`true` enables busy status and `false` disables busy status

Check User Busy status is enabled#

User can check whether their busy status is enabled or disabled.

FlyChat.isBusyStatusEnabled().then((bool? value){

}).catchError((er){
   // Error handling
});

Get the list of User saved profile statuses#

User can get their list of previously saved user statuses by calling the below method.

FlyChat.getProfileStatusList().then((value){
   var data = statusDataFromJson(value);
}).catchError((er){
   // Error handling
});

info

This list contains some pre defined values.

Get the list of User saved busy statuses#

User can get their list of previously saved user busy statuses by calling the below method.

FlyChat.getBusyStatusList().then((value){

}).catchError((er){
   // Error handling
});

info

This list also contains some pre defined values.

Delete a user Status#

User can delete their user status by calling the below method.

FlyChat.deleteProfileStatus(USER_STATUS).then((bool? value){

}).catchError((er){
   // Error handling
});

Argument	Type	Description
USER_STATUS	`ProfileStatus`	Object of the profile status that has to be deleted

caution

User cannot delete a status which is currently selected.

Delete a user Busy Status#

User can delete their busy status by calling the below method.

FlyChat.deleteBusyStatus(USER_BUSY_STATUS).then((bool? value){

}).catchError((er){
   // Error handling
});

Argument	Type	Description
USER_BUSY_STATUS	`BusyStatus`	Object of the user busy status that has to be deleted

caution

User cannot delete a busy status which is currently selected.

Enable disable hide seen status#

Hide Last seen status enables the user's last logged in time unavailable to their friends. To enable or disable the hide last seen status of the user call the below method.

FlyChat.enableDisableHideLastSeen(ENABLE_LAST_SEEN).then((bool? value){

}).catchError((er){
   // Error handling
});

Argument	Type	Description
ENABLE_LAST_SEEN	`boolean`	`true` enables the last seen available to friends `false` disables it
CALLBACK	`FlyCallback`	`FlyCallback` implemented as lambda expression

Check last seen status#

To check whether last seen status is available to friends or not, call the below method.

FlyChat.isHideLastSeenEnabled().then((bool? value){

}).catchError((er){
   // Error handling
});