Preparing search index...
The search index is not available
XYO Platform SDK - v3.6.9
XYO Platform SDK
@xyo-network/sdk-utils
ApiConfig
Interface ApiConfig
interface
ApiConfig
{
apiDomain
:
string
;
apiKey
?:
string
;
compressionThreshold
?:
number
;
jwtToken
?:
string
;
onError
?:
(
error
:
ApiError
,
depth
:
number
)
=>
void
;
onFailure
?:
(
response
:
ApiResponse
<
unknown
,
unknown
>
,
depth
:
number
,
)
=>
void
;
onSuccess
?:
(
response
:
ApiResponse
<
unknown
,
unknown
>
,
depth
:
number
,
)
=>
void
;
query
?:
string
;
reportableParent
?:
ApiReportable
;
root
?:
string
;
throwError
?:
boolean
;
throwFailure
?:
boolean
;
userid
?:
string
;
}
Hierarchy (
View Summary
)
ApiReportable
ApiConfig
Index
Properties
api
Domain
api
Key?
compression
Threshold?
jwt
Token?
on
Error?
on
Failure?
on
Success?
query?
reportable
Parent?
root?
throw
Error?
throw
Failure?
userid?
Properties
api
Domain
apiDomain
:
string
Optional
api
Key
apiKey
?:
string
Optional
compression
Threshold
compressionThreshold
?:
number
Optional
jwt
Token
jwtToken
?:
string
Optional
on
Error
onError
?:
(
error
:
ApiError
,
depth
:
number
)
=>
void
Optional
on
Failure
onFailure
?:
(
response
:
ApiResponse
<
unknown
,
unknown
>
,
depth
:
number
)
=>
void
Optional
on
Success
onSuccess
?:
(
response
:
ApiResponse
<
unknown
,
unknown
>
,
depth
:
number
)
=>
void
Optional
query
query
?:
string
Optional
reportable
Parent
reportableParent
?:
ApiReportable
Optional
root
root
?:
string
Optional
throw
Error
throwError
?:
boolean
Optional
throw
Failure
throwFailure
?:
boolean
Optional
userid
userid
?:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
api
Domain
api
Key
compression
Threshold
jwt
Token
on
Error
on
Failure
on
Success
query
reportable
Parent
root
throw
Error
throw
Failure
userid
XYO Platform SDK - v3.6.9
Loading...