@espressif/rainmaker-base-cdf
Preparing search index...
types/adaptor
ESPSDKAdaptor
Interface ESPSDKAdaptor
interface
ESPSDKAdaptor
{
_identifier
:
string
;
config
:
Record
<
string
,
any
>
;
confirmSignUp
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFConfirmSignUpRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
;
forgotPassword
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFForgotPasswordRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
;
getCurrentLoggedInUser
()
:
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
;
getSignUpCode
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFGetSignUpCodeRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
;
login
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFLoginRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
;
loginWithOauth
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFLoginWithOauthRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
;
setNewPassword
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFSetNewPasswordRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
;
}
Index
Properties
_
identifier
config
Methods
confirm
Sign
Up
forgot
Password
get
Current
Logged
In
User
get
Sign
Up
Code
login
login
With
Oauth
set
New
Password
Properties
Readonly
_
identifier
_identifier
:
string
Readonly
config
config
:
Record
<
string
,
any
>
Methods
confirm
Sign
Up
confirmSignUp
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFConfirmSignUpRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
Parameters
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFConfirmSignUpRequestPayload
>
Returns
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
forgot
Password
forgotPassword
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFForgotPasswordRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
Parameters
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFForgotPasswordRequestPayload
>
Returns
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
get
Current
Logged
In
User
getCurrentLoggedInUser
()
:
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
Returns
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
get
Sign
Up
Code
getSignUpCode
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFGetSignUpCodeRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
Parameters
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFGetSignUpCodeRequestPayload
>
Returns
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
login
login
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFLoginRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
Parameters
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFLoginRequestPayload
>
Returns
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
login
With
Oauth
loginWithOauth
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFLoginWithOauthRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
Parameters
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFLoginWithOauthRequestPayload
>
Returns
Promise
<
ESPSDKAdaptorAPIDataResponse
<
ESPCDFUser
>
>
set
New
Password
setNewPassword
(
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFSetNewPasswordRequestPayload
>
,
)
:
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
Parameters
request
:
ESPSDKAdaptorAPIRequest
<
ESPCDFSetNewPasswordRequestPayload
>
Returns
Promise
<
ESPSDKAdaptorAPIResponse
<
any
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
_
identifier
config
Methods
confirm
Sign
Up
forgot
Password
get
Current
Logged
In
User
get
Sign
Up
Code
login
login
With
Oauth
set
New
Password
@espressif/rainmaker-base-cdf
Loading...