Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Login

The userLogin method is used to authenticate a user with a username and password.

...

Parameter

Type

Description

userName

String

The user’s username.

password

String

The user’s password.

success

Closure

A closure called when the authentication is successful.

failure

Closure

A closure called when the authentication fails, with the error parameter.

Example Usage

Code Block
AuthenticateService.shared.userLogin(userName: username, password: password, success: { 
    // Authentication successful
    // Perform any actions or navigate to the next screen
}, failure: { error in
    // Authentication failed
    // Handle the error or display an error message
})

Guest Login

The userLogin method is used to authenticate a user with a username and password.

...

Parameter

Type

Description

firstName

String

The guest’s first name.

lastName

String

The guest’s last name.

success

Closure

A closure called when the authentication is successful.

failure

Closure

A closure called when the authentication fails, with the error parameter.

Example Usage

Code Block
AuthenticateService.shared.userLogin(firstName, lastName: lastName, success: {
        // Guest login successful
    // Perform any actions or navigate to the next screen
}, failure: { error in
    // Guest login failed
    // Handle the error or display an error message
})

Login By Token (SSO)

The loginBySSOToken method is used to authenticate a user using a single sign-on (SSO) token.

...

Parameter

Type

Description

token

String

The single sign-on token.

success

Closure

A closure called when the authentication is successful.

failure

Closure

A closure called when the authentication fails, with the error parameter.

Example Usage

Code Block
// Perform authentication using the provided SSO token
AuthenticateService.shared.loginBySSOToken(ssoToken, success: { 
    // Authentication successful
    // Perform any actions or navigate to the next screen
}, failure: { error in
    // Authentication failed
    // Handle the error or display an error message
})

Logout

The logoutVC method is used to log out of the VSee Clinic session.

...

Parameter

Type

Description

success

Closure

A closure called when the logout is successful.

failure

Closure

A closure called when the logout fails, with the error parameter.

Example Usage

Code Block
AuthenticateService.shared.logoutVC(success: {
    // Logout successful
    // Perform actions after successful logout
}) { error in
    // Logout failed
    // Handle the error or display an error message
}

Restore Logged in Session

The restoreLoginSession method is used to restore a login session.

...

Parameter

Type

Description

success

Closure

A closure called when the login session is successfully restored.

failure

Closure

A closure called when restoring the login session fails, with the error parameter.

Example Usage

Code Block
// Restore the login session for the previously logged-in user
AuthenticateService.shared.restoreLoginSession(success: {
    // Login session restored successfully
    // Perform any necessary actions or navigate to the next screen
}, failure: { error in
    // Failed to restore the login session
    // Handle the error or display an error message
})

...