[iOS] Authentication API

1 Login
- 1.1 Example Usage
2 Guest Login
- 2.1 Example Usage
3 Login By Token (SSO)
- 3.1 Example Usage
4 Logout
- 4.1 Example Usage
5 Restore Logged in Session
- 5.1 Example Usage

Login

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

public func userLogin(userName: String, 
                      password: String, 
                      success: @escaping() -> Void, 
                      failure: @escaping (Error) -> Void)

Parameter	Type	Description

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

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.

public func guestLogin(_ firstName: String, 
                          lastName: String, 
                          success: @escaping() -> Void, 
                          failure: @escaping (Error) -> Void)

Parameter	Type	Description

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

Login By Token (SSO)

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

Parameter	Type	Description

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

Logout

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

Parameter	Type	Description

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

Restore Logged in Session

The restoreLoginSession method is used to restore a login session.

Parameter	Type	Description

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.