selected title

On this page
Authentication
Method Method detail
registerUser() Used to initiate User Registration. This method returns created User information for further process i.e. Authentication.
authenticateUser() Used to initiate User Signin and to determine whether the user is valid to authenticate or not.
socialLogin() It validates the social user.
forgetPassword() Used to request the password of the user on email id passed as parameter.
changePassword() Used to change the password of the logged in user.
deleteUserAccount() is used to delete the current logged in user’s profile from the system.
logout() It logs out the user and deletes all user data from the device. After calling this method, isUserLoggedIn() will return false since the user is logged out.
isUserLogedin() It returns true if the user is currently logged-in and false if the user is logged out.
  • For Sign up
    API Class : UserAuthenticationInteractor
    Method : registerUser
    Used to initiate User Registration. This method returns created User information for further process i.e. Authentication.
    Request:
    • Request Object : SignUpRequest
    • Parameters
    • FullName : User full name
    • Email : User email address
    • Password : User password
    • DeviceId : Android unique id
    • DeviceType : Android
    • PlanType : 1
    • userName: Suggested user name (Refer checkUserNameAvailability() of ProfileInteractor Class)
    • termConditionAccepted: Boolean, true or false
    • metaKeys: c an be used to send any meta value in string format
    Response:
    • Response Object : SignUpInfo
    • StatusCode : It returns api status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
    • Message : It is simple string message
  • For Sign In
    API Class : UserAuthenticationInteractor
    Method : authenticateUser
    Used to initiate User Signin and to determine whether the user is valid to authenticate or not.
    Request:
    • Request Object : SignInReq
    • Parameters
    • Email : User email address
    • Password : User password
    • DeviceId : Android unique id
    • DeviceType : Android
    • firebaseToken: optional(fcm token)
    • metaKeys: can be used to send any meta value in string format
    Response:
    • Response Object : SignInResponse
    • StatusCode : It returns api status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
    • Message : It is simple string message
    • data : user related data
  • For Social Login
    API Class : UserAuthenticationInteractor
    Method : socialLogin
    It validates the social user.
    Request:
    • Request Object : SocialLogInReq
    • Parameters
    • Email: Email address,
    • FullName : User full name
    • UserId : social account user id,
    • userName : social account username,
    • ProfileImageUrl : social profile image,
    • DeviceId : Android unique id,
    • DeviceType : Android,
    • Type : google/facebook,
    • SocialType : login/signup
    • metaKeys : can be used to send any meta value in string format
    Response:
    • Response Object : SignInResponse
    • StatusCode : It returns api status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
    • Message : It is simple string message
    • data : user related data
  • For Forgot Password
    API Class : UserAuthenticationInteractor
    Method : forgotPassword()
    Used to request the password of the user on email id passed as parameter.
    Request:
    • Parameters
    • Email: email id of the user
    API Response:
    • Response Object : CommonResponse
    • Message : It is simple string message
    • StatusCode : It returns api status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
  • For Change Password
    API Class : UserAuthenticationInteractor
    Method : changePassword()
    Used to change the password of the logged in user.
    Request:
    • Request Object : ChangePasswordReqDto
    • Parameters
    • newPassword: new password
    • oldPassword : old Password
    Response:
    • Response Object : CommonResponse
    • Message : It is simple string message
    • StatusCode : It returns api status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
  • For Delete User Account
    API Class : UserAuthenticationInteractor
    Method : deleteUserAccount()
    It is used to delete the current logged in user’s profile from the system.
    For Logout Use
    • Response Object : DeleteResponse
    • Message : It is simple string message
    • StatusCode : It returns api status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
  • For Logout Use
    API Class : UserAuthenticationInteractor
    Method : logout()
    It logs out the user and deletes all user data from the device. After calling this method, isUserLoggedIn() will return false since the user is logged out.
    API Request - NA
    API Response -NA
  • To check whether the user is logged in or not
    API Class : UserAuthenticationInteractor
    Method : isUserLoggedIn()
    It returns true if the user is currently logged-in and false if the user is logged out.
    Request - NA
    Response -NA