jamespot-user-api
Preparing search index...
JGlobalApi
Class JGlobalApi
Hierarchy (
View Summary
)
JBaseApi
JGlobalApi
Index
Constructors
constructor
Properties
j
Api
network
Methods
add
Action
count
Action
get
Users
remove
Action
update
Action
use
Web
Version
Constructors
constructor
new
JGlobalApi
(
jApi
:
JamespotUserApi
)
:
JGlobalApi
Parameters
jApi
:
JamespotUserApi
Returns
JGlobalApi
Properties
j
Api
jApi
:
JamespotUserApi
network
network
:
Network
Methods
add
Action
addAction
<
T
extends
{
dateCreation
?:
string
;
dateModified
?:
string
|
null
;
id
:
number
;
mainType
:
string
;
srcId
:
number
;
srcType
:
string
;
targetId
:
number
;
targetType
:
string
|
null
;
type
:
string
;
uri
:
string
;
}
=
{
dateCreation
?:
string
;
dateModified
?:
string
|
null
;
id
:
number
;
mainType
:
string
;
srcId
:
number
;
srcType
:
string
;
targetId
:
number
;
targetType
:
string
|
null
;
type
:
string
;
uri
:
string
;
}
,
>
(
params
:
ActionParams
,
format
?:
"raw-little"
|
"raw-list"
|
"raw-view"
,
)
:
Promise
<
ApiWrapper
<
T
,
BaseMessages
>
>
Type Parameters
T
extends
{
dateCreation
?:
string
;
dateModified
?:
string
|
null
;
id
:
number
;
mainType
:
string
;
srcId
:
number
;
srcType
:
string
;
targetId
:
number
;
targetType
:
string
|
null
;
type
:
string
;
uri
:
string
;
}
=
{
dateCreation
?:
string
;
dateModified
?:
string
|
null
;
id
:
number
;
mainType
:
string
;
srcId
:
number
;
srcType
:
string
;
targetId
:
number
;
targetType
:
string
|
null
;
type
:
string
;
uri
:
string
;
}
Parameters
params
:
ActionParams
Optional
format
:
"raw-little"
|
"raw-list"
|
"raw-view"
Returns
Promise
<
ApiWrapper
<
T
,
BaseMessages
>
>
count
Action
countAction
(
verb
:
"read"
,
uri
:
string
,
)
:
Promise
<
ApiWrapper
<
number
,
BaseMessages
>
>
Parameters
verb
:
"read"
uri
:
string
Returns
Promise
<
ApiWrapper
<
number
,
BaseMessages
>
>
get
Users
getUsers
<
T
extends
jUserLittle
=
jUserList
>
(
params
:
ActionParams
,
format
?:
"raw-little"
|
"raw-list"
|
"raw-view"
,
)
:
Promise
<
ApiWrapper
<
T
[]
,
BaseMessages
>
>
Type Parameters
T
extends
jUserLittle
=
jUserList
Parameters
params
:
ActionParams
Optional
format
:
"raw-little"
|
"raw-list"
|
"raw-view"
Returns
Promise
<
ApiWrapper
<
T
[]
,
BaseMessages
>
>
remove
Action
removeAction
(
params
:
ActionParams
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
Parameters
params
:
ActionParams
Optional
options
:
{
signal
?:
AbortSignal
}
Returns
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
update
Action
updateAction
<
T
>
(
params
:
ActionUpdateParamsSchema
<
T
>
,
options
?:
{
signal
?:
AbortSignal
}
,
)
:
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
Type Parameters
T
Parameters
params
:
ActionUpdateParamsSchema
<
T
>
Optional
options
:
{
signal
?:
AbortSignal
}
Returns
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
use
Web
Version
useWebVersion
()
:
Promise
<
ApiWrapper
<
unknown
,
BaseMessages
>
>
Returns
Promise
<
ApiWrapper
<
unknown
,
BaseMessages
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
j
Api
network
Methods
add
Action
count
Action
get
Users
remove
Action
update
Action
use
Web
Version
jamespot-user-api
Loading...