RTSDK
NPM Package
Demo
Preparing search index...
interfaces
UserInterface
Interface UserInterface
interface
UserInterface
{
dataObject
?:
null
|
object
;
addAvatar
(
formData
:
FormData
)
:
Promise
<
void
|
ResponseType
>
;
checkInteractiveCredentials
()
:
Promise
<
void
|
ResponseType
>
;
deleteAvatar
(
avatarId
:
string
)
:
Promise
<
void
|
ResponseType
>
;
fetchAssets
()
:
Promise
<
void
|
ResponseType
>
;
fetchAvatars
()
:
Promise
<
void
|
ResponseType
>
;
fetchDataObject
(
appPublicKey
?:
string
,
appJWT
?:
string
,
)
:
Promise
<
void
|
ResponseType
>
;
fetchPlatformAssets
()
:
Promise
<
object
|
ResponseType
>
;
fetchScenes
()
:
Promise
<
void
|
ResponseType
>
;
fetchWorldsByKey
()
:
Promise
<
void
|
ResponseType
>
;
getExpressions
(
__namedParameters
:
{
getUnlockablesOnly
?:
boolean
;
name
?:
string
}
,
)
:
Promise
<
ResponseType
>
;
incrementDataObjectValue
(
path
:
string
,
amount
:
number
,
options
:
object
,
)
:
Promise
<
void
|
ResponseType
>
;
sendEmail
(
__namedParameters
:
{
html
:
string
;
subject
:
string
;
to
:
string
}
,
)
:
Promise
<
object
|
ResponseType
>
;
setDataObject
(
dataObject
:
undefined
|
null
|
object
,
options
:
object
,
)
:
Promise
<
void
|
ResponseType
>
;
updateAvatar
(
avatarId
:
string
,
formData
:
FormData
,
)
:
Promise
<
void
|
ResponseType
>
;
}
Implemented by
User
Index
Properties
data
Object?
Methods
add
Avatar
check
Interactive
Credentials
delete
Avatar
fetch
Assets
fetch
Avatars
fetch
Data
Object
fetch
Platform
Assets
fetch
Scenes
fetch
Worlds
By
Key
get
Expressions
increment
Data
Object
Value
send
Email
set
Data
Object
update
Avatar
Properties
Optional
data
Object
dataObject
?:
null
|
object
Methods
add
Avatar
addAvatar
(
formData
:
FormData
)
:
Promise
<
void
|
ResponseType
>
Parameters
formData
:
FormData
Returns
Promise
<
void
|
ResponseType
>
check
Interactive
Credentials
checkInteractiveCredentials
()
:
Promise
<
void
|
ResponseType
>
Returns
Promise
<
void
|
ResponseType
>
delete
Avatar
deleteAvatar
(
avatarId
:
string
)
:
Promise
<
void
|
ResponseType
>
Parameters
avatarId
:
string
Returns
Promise
<
void
|
ResponseType
>
fetch
Assets
fetchAssets
()
:
Promise
<
void
|
ResponseType
>
Returns
Promise
<
void
|
ResponseType
>
fetch
Avatars
fetchAvatars
()
:
Promise
<
void
|
ResponseType
>
Returns
Promise
<
void
|
ResponseType
>
fetch
Data
Object
fetchDataObject
(
appPublicKey
?:
string
,
appJWT
?:
string
,
)
:
Promise
<
void
|
ResponseType
>
Parameters
Optional
appPublicKey
:
string
Optional
appJWT
:
string
Returns
Promise
<
void
|
ResponseType
>
fetch
Platform
Assets
fetchPlatformAssets
()
:
Promise
<
object
|
ResponseType
>
Returns
Promise
<
object
|
ResponseType
>
fetch
Scenes
fetchScenes
()
:
Promise
<
void
|
ResponseType
>
Returns
Promise
<
void
|
ResponseType
>
fetch
Worlds
By
Key
fetchWorldsByKey
()
:
Promise
<
void
|
ResponseType
>
Returns
Promise
<
void
|
ResponseType
>
get
Expressions
getExpressions
(
__namedParameters
:
{
getUnlockablesOnly
?:
boolean
;
name
?:
string
}
,
)
:
Promise
<
ResponseType
>
Parameters
__namedParameters
:
{
getUnlockablesOnly
?:
boolean
;
name
?:
string
}
Returns
Promise
<
ResponseType
>
increment
Data
Object
Value
incrementDataObjectValue
(
path
:
string
,
amount
:
number
,
options
:
object
,
)
:
Promise
<
void
|
ResponseType
>
Parameters
path
:
string
amount
:
number
options
:
object
Returns
Promise
<
void
|
ResponseType
>
send
Email
sendEmail
(
__namedParameters
:
{
html
:
string
;
subject
:
string
;
to
:
string
}
,
)
:
Promise
<
object
|
ResponseType
>
Parameters
__namedParameters
:
{
html
:
string
;
subject
:
string
;
to
:
string
}
Returns
Promise
<
object
|
ResponseType
>
set
Data
Object
setDataObject
(
dataObject
:
undefined
|
null
|
object
,
options
:
object
,
)
:
Promise
<
void
|
ResponseType
>
Parameters
dataObject
:
undefined
|
null
|
object
options
:
object
Returns
Promise
<
void
|
ResponseType
>
update
Avatar
updateAvatar
(
avatarId
:
string
,
formData
:
FormData
)
:
Promise
<
void
|
ResponseType
>
Parameters
avatarId
:
string
formData
:
FormData
Returns
Promise
<
void
|
ResponseType
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
data
Object
Methods
add
Avatar
check
Interactive
Credentials
delete
Avatar
fetch
Assets
fetch
Avatars
fetch
Data
Object
fetch
Platform
Assets
fetch
Scenes
fetch
Worlds
By
Key
get
Expressions
increment
Data
Object
Value
send
Email
set
Data
Object
update
Avatar
NPM Package
Demo
RTSDK
Loading...