Class UserService

Hierarchy

UserService

Index

Constructors

Properties

Methods

getCurrentUser getOnAuthStateChangedData linkSSOSession login loginWithIDPResult loginWithMic loginWithRopcAAD loginWithRopcISAM loginWithSSO loginWithSSOForMobileNS6 loginWithSSOForMobileRN logout startPhoneLogin verifyPhoneLogin

Constructors

constructor

new UserService(): UserService
Creates an instance of UserService.

Memberof
UserService

Returns UserService
- Defined in src/lib/user/user.ts:39

Properties

`Private` customEndPointService

customEndPointService: CustomEndPointService

Methods

getCurrentUser

getCurrentUser(): any
The getCurrentUser method returns current logged in user's information.

Returns
Object

Memberof
UserService

Returns any
- Defined in src/lib/user/user.ts:237

getOnAuthStateChangedData

getOnAuthStateChangedData(callback: any): Unsubscribe
The getOnAuthStateChangedData is used to get the current user is by setting an observer on the Auth object.

Memberof
UserService
Parameters
- callback: any
  
  its kind of callback function.
Returns Unsubscribe
- Defined in src/lib/user/user.ts:313

linkSSOSession

linkSSOSession(providerId: string, params: OIDCSSOParams): Promise<UserCredential>
Returns
Parameters
- providerId: string
  
  provider ID for linking sso session
- params: OIDCSSOParams
Returns Promise<UserCredential>
- Defined in src/lib/user/user.ts:146

login

login(email: string, password: string): Promise<UserCredential>
The login method accepts email address and password. If authentication is successful, returns the authenticated user.

Returns
Promise

Memberof
UserService
Parameters
- email: string
  
  The users email address.
- password: string
  
  The users password.
Returns Promise<UserCredential>
- Defined in src/lib/user/user.ts:50

loginWithIDPResult

loginWithIDPResult(): Promise<null | UserCredential>
The loginWithIDPResult is used to returns the authenticated user data.

Returns
Promise<UserCredential | null>

Memberof
UserService

Returns Promise<null | UserCredential>
- Defined in src/lib/user/user.ts:59

loginWithMic

loginWithMic(provider: string, providerId: string, scope?: string | string[]): void
The loginWithMic method accepts providerName, providerIdentity and scope. If authentication is successful, returns the authenticated user.

Returns
void

Memberof
UserService
Parameters
- provider: string
  
  Identity provider name
- providerId: string
  
  Provider's SSO url
- Optional scope: string | string[]
  
  string or Array of string values
Returns void
- Defined in src/lib/user/user.ts:159

loginWithRopcAAD

loginWithRopcAAD(username: string, password: string): Promise<void>
loginWithRopcAAD method accepts username and password to authenticate the user, if success returns the authenticated user.

Returns
void
Parameters
- username: string
- password: string
Returns Promise<void>
- Defined in src/lib/user/user.ts:184

loginWithRopcISAM

loginWithRopcISAM(username: string, password: string): Promise<void>
loginWithRopcISAM method accepts username and password to authenticate the user, if success returns the authenticated user.

Returns
void
Parameters
- username: string
- password: string
Returns Promise<void>
- Defined in src/lib/user/user.ts:211

loginWithSSO

loginWithSSO(linkUrl?: any): void
The loginWithSSO is used to authenticate with Azure AD. If authentication is successful, returns the authenticated user. a *

Returns
void

Memberof
UserService
Parameters
- Optional linkUrl: any
  
  linking method to open the url
Returns void
- Defined in src/lib/user/user.ts:69

`Private` loginWithSSOForMobileNS6

loginWithSSOForMobileNS6(linkUrl: any): Promise<void>
The loginWithSSOForMobileNS6 is used to authenticate with SSO on Mobile apps based on the target nativescript framework.

Returns
Promise

Memberof
UserService
Parameters
- linkUrl: any
  
  linking method to open the url
Returns Promise<void>
- Defined in src/lib/user/user.ts:96

`Private` loginWithSSOForMobileRN

loginWithSSOForMobileRN(linkUrl: any): Promise<void>
The loginWithSSOForMobileRN is used to authenticate with SSO on Mobile apps based on the target react-native framework.

Returns
Promise

Memberof
UserService
Parameters
- linkUrl: any
  
  linking method to open the url
Returns Promise<void>
- Defined in src/lib/user/user.ts:117

logout

logout(): Promise<unknown>
The logout method clear/remove the user session.

Returns
Promise

Memberof
UserService

Returns Promise<unknown>
- Defined in src/lib/user/user.ts:268

startPhoneLogin

startPhoneLogin(phoneNumber: string, captcha: ApplicationVerifier): Promise<ConfirmationResult>
The startPhoneLogin method accepts phone number and captcha. It sends SMS message to the user's phone. The user signs in using a one-time code contained in the SMS message.

Returns
Promise

Memberof
UserService
Parameters
- phoneNumber: string
  
  The user's phone number.
- captcha: ApplicationVerifier
  
  captcha If application send third party captcha
Returns Promise<ConfirmationResult>
- Defined in src/lib/user/user.ts:293

verifyPhoneLogin

verifyPhoneLogin(confirmationResult: ConfirmationResult, verificationCode: string): Promise<UserCredential>
The verifyPhoneLogin method accepts confirmationResult and verificationCode. If authentication is successful, returns the authenticated user.

Returns
Promise

Memberof
UserService
Parameters
- confirmationResult: ConfirmationResult
  
  Return data from startPhoneLogin method.
- verificationCode: string
Returns Promise<UserCredential>
- Defined in src/lib/user/user.ts:304

Class UserService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Memberof

Returns UserService

Properties

Private customEndPointService

Methods

getCurrentUser

Returns

Memberof

Returns any

getOnAuthStateChangedData

Memberof

Parameters

callback: any

Returns Unsubscribe

linkSSOSession

Returns

Parameters

providerId: string

params: OIDCSSOParams

Returns Promise<UserCredential>

login

Returns

Memberof

Parameters

email: string

password: string

Returns Promise<UserCredential>

loginWithIDPResult

Returns

Memberof

Returns Promise<null | UserCredential>

loginWithMic

Returns

Memberof

Parameters

provider: string

providerId: string

Optional scope: string | string[]

Returns void

loginWithRopcAAD

Returns

Parameters

username: string

password: string

Returns Promise<void>

loginWithRopcISAM

Returns

Parameters

username: string

password: string

Returns Promise<void>

loginWithSSO

Returns

Memberof

Parameters

Optional linkUrl: any

Returns void

Private loginWithSSOForMobileNS6

Returns

Memberof

Parameters

linkUrl: any

Returns Promise<void>

Private loginWithSSOForMobileRN

Returns

Memberof

Parameters

linkUrl: any

Returns Promise<void>

logout

Returns

Memberof

`Private` customEndPointService

`Optional` scope: string | string[]

`Optional` linkUrl: any

`Private` loginWithSSOForMobileNS6

`Private` loginWithSSOForMobileRN