jamespot-user-api
Preparing search index...
JObjectApi
Class JObjectApi
Hierarchy (
View Summary
)
JBaseApi
JObjectApi
Index
Constructors
constructor
Properties
j
Api
network
Methods
ask
Access
get
Access
get
Access
Hash
get
Access
Request
get
Object
set
Access
set
Access
Request
Constructors
constructor
new
JObjectApi
(
jApi
:
JamespotUserApi
)
:
JObjectApi
Parameters
jApi
:
JamespotUserApi
Returns
JObjectApi
Properties
j
Api
jApi
:
JamespotUserApi
network
network
:
Network
Methods
ask
Access
askAccess
(
uri
:
string
,
askAccess
:
"read"
|
"write"
,
askMessage
?:
string
,
)
:
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
Parameters
uri
:
string
askAccess
:
"read"
|
"write"
Optional
askMessage
:
string
Returns
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
get
Access
getAccess
(
uri
:
string
)
:
Promise
<
ApiWrapper
<
ShareAccessProps
,
BaseMessages
>
>
Parameters
uri
:
string
Returns
Promise
<
ApiWrapper
<
ShareAccessProps
,
BaseMessages
>
>
get
Access
Hash
getAccessHash
(
uri
:
string
)
:
Promise
<
ApiWrapper
<
string
,
BaseMessages
>
>
Parameters
uri
:
string
Returns
Promise
<
ApiWrapper
<
string
,
BaseMessages
>
>
get
Access
Request
getAccessRequest
(
uri
:
string
,
idUser
?:
number
,
)
:
Promise
<
ApiWrapper
<
jUserLittle
[]
,
BaseMessages
>
>
Parameters
uri
:
string
Optional
idUser
:
number
Returns
Promise
<
ApiWrapper
<
jUserLittle
[]
,
BaseMessages
>
>
get
Object
getObject
(
uri
:
string
)
:
Promise
<
ApiWrapper
<
jObjectLittle
,
BaseMessages
>
>
Parameters
uri
:
string
Returns
Promise
<
ApiWrapper
<
jObjectLittle
,
BaseMessages
>
>
set
Access
setAccess
(
uri
:
string
,
access
:
{
read
:
string
[]
;
write
:
string
[]
}
,
message
:
string
,
generalAccessRule
:
"link"
|
"invitation"
,
)
:
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
Parameters
uri
:
string
access
:
{
read
:
string
[]
;
write
:
string
[]
}
message
:
string
generalAccessRule
:
"link"
|
"invitation"
Returns
Promise
<
ApiWrapper
<
boolean
,
BaseMessages
>
>
set
Access
Request
setAccessRequest
(
uri
:
string
,
idUser
:
number
,
requestAccessValue
:
"accept"
|
"deny"
,
requestResponseMessage
?:
string
,
)
:
Promise
<
ApiWrapper
<
[
]
,
BaseMessages
>
>
Parameters
uri
:
string
idUser
:
number
requestAccessValue
:
"accept"
|
"deny"
Optional
requestResponseMessage
:
string
Returns
Promise
<
ApiWrapper
<
[
]
,
BaseMessages
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
j
Api
network
Methods
ask
Access
get
Access
get
Access
Hash
get
Access
Request
get
Object
set
Access
set
Access
Request
jamespot-user-api
Loading...