Preparing search index...
The search index is not available
Realtime Web Suite Client package
Realtime Web Suite Client package
ApiServiceInstance
Class ApiServiceInstance
Hierarchy (
view full
)
RWSService
ApiServiceInstance
Index
Constructors
constructor
Properties
_RELOADABLE
back
token?
_instances
Methods
add
Header
connect
To
Amplify
delete
get
get
Backend
Url
get
Headers
get
Reloadable
post
pure
Get
put
reload
Service
set
Token
upload
File
get
Singleton
Constructors
constructor
new
Api
Service
Instance
(
)
:
ApiServiceInstance
Returns
ApiServiceInstance
Properties
_RELOADABLE
_RELOADABLE
:
boolean
= false
back
back
:
{
delete
:
(
<
T
>
(
routeName
,
options
?
)
=>
Promise
<
T
>
)
;
get
:
(
<
T
>
(
routeName
,
options
?
)
=>
Promise
<
T
>
)
;
post
:
(
<
T
,
P
>
(
routeName
,
payload
?
,
options
?
)
=>
Promise
<
T
>
)
;
put
:
(
<
T
,
P
>
(
routeName
,
payload
,
options
?
)
=>
Promise
<
T
>
)
;
uploadFile
:
(
(
routeName
,
file
,
onProgress
,
options
?
)
=>
Promise
<
UploadResponse
>
)
;
}
= ...
Type declaration
delete
:
(
<
T
>
(
routeName
,
options
?
)
=>
Promise
<
T
>
)
<
T
>
(
routeName
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
Parameters
routeName
:
string
Optional
options
:
IAPIOptions
Returns
Promise
<
T
>
get
:
(
<
T
>
(
routeName
,
options
?
)
=>
Promise
<
T
>
)
<
T
>
(
routeName
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
Parameters
routeName
:
string
Optional
options
:
IAPIOptions
Returns
Promise
<
T
>
post
:
(
<
T
,
P
>
(
routeName
,
payload
?
,
options
?
)
=>
Promise
<
T
>
)
<
T
,
P
>
(
routeName
,
payload
?
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
P
Parameters
routeName
:
string
Optional
payload
:
P
Optional
options
:
IAPIOptions
Returns
Promise
<
T
>
put
:
(
<
T
,
P
>
(
routeName
,
payload
,
options
?
)
=>
Promise
<
T
>
)
<
T
,
P
>
(
routeName
,
payload
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
P
Parameters
routeName
:
string
payload
:
P
Optional
options
:
IAPIOptions
Returns
Promise
<
T
>
upload
File
:
(
(
routeName
,
file
,
onProgress
,
options
?
)
=>
Promise
<
UploadResponse
>
)
(
routeName
,
file
,
onProgress
,
options
?
)
:
Promise
<
UploadResponse
>
Parameters
routeName
:
string
file
:
File
onProgress
:
(
(
progress
)
=>
void
)
(
progress
)
:
void
Parameters
progress
:
number
Returns
void
options
:
IAPIOptions
= {}
Returns
Promise
<
UploadResponse
>
Private
Optional
token
token
?:
string
Static
Protected
_instances
_instances
:
{
[
key
:
string
]
:
RWSService
;
}
= {}
Type declaration
[
key
:
string
]:
RWSService
Methods
Private
add
Header
add
Header
(
headers
,
key
,
val
)
:
void
Parameters
headers
:
[
string
,
string
]
[]
|
Headers
|
{
[
key
:
string
]
:
string
;
}
key
:
string
val
:
string
Returns
void
connect
To
Amplify
connect
To
Amplify
(
)
:
void
Returns
void
delete
delete
<
T
>
(
url
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
Parameters
url
:
string
options
:
IAPIOptions
= {}
Returns
Promise
<
T
>
get
get
<
T
>
(
url
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
Parameters
url
:
string
options
:
IAPIOptions
= {}
Returns
Promise
<
T
>
Private
get
Backend
Url
get
Backend
Url
(
routeName
,
params
?
)
:
string
Parameters
routeName
:
string
params
:
{
[
key
:
string
]
:
string
;
}
= {}
[
key
:
string
]:
string
Returns
string
Private
get
Headers
get
Headers
(
optHeaders
?
)
:
HeadersInit
Parameters
optHeaders
:
HeadersInit
= {}
Returns
HeadersInit
get
Reloadable
get
Reloadable
(
)
:
string
Returns
string
post
post
<
T
,
P
>
(
url
,
payload
?
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
P
Parameters
url
:
string
Optional
payload
:
P
options
:
IAPIOptions
= {}
Returns
Promise
<
T
>
pure
Get
pure
Get
(
url
,
options
?
)
:
Promise
<
string
>
Parameters
url
:
string
options
:
IAPIOptions
= {}
Returns
Promise
<
string
>
put
put
<
T
,
P
>
(
url
,
payload
?
,
options
?
)
:
Promise
<
T
>
Type Parameters
T
P
Parameters
url
:
string
Optional
payload
:
P
options
:
IAPIOptions
= {}
Returns
Promise
<
T
>
reload
Service
reload
Service
<
T
>
(
this
,
...
params
)
:
InstanceType
<
T
>
Type Parameters
T
extends
(
new
(
...
args
)
=>
RWSService
)
Parameters
this
:
T
Rest
...
params
:
any
[]
Returns
InstanceType
<
T
>
set
Token
set
Token
(
token
)
:
void
Parameters
token
:
string
Returns
void
upload
File
upload
File
(
url
,
file
,
onProgress
,
options
?
)
:
Promise
<
UploadResponse
>
Parameters
url
:
string
file
:
File
onProgress
:
(
(
progress
)
=>
void
)
(
progress
)
:
void
Parameters
progress
:
number
Returns
void
options
:
IAPIOptions
= {}
Returns
Promise
<
UploadResponse
>
Static
get
Singleton
get
Singleton
<
T
>
(
this
)
:
InstanceType
<
T
>
Type Parameters
T
extends
(
new
(
...
args
)
=>
RWSService
)
Parameters
this
:
T
Returns
InstanceType
<
T
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
_RELOADABLE
back
token
_instances
add
Header
connect
To
Amplify
delete
get
get
Backend
Url
get
Headers
get
Reloadable
post
pure
Get
put
reload
Service
set
Token
upload
File
get
Singleton
src
services
ApiService.ts
ApiServiceInstance
IRWSHttpRoute
IRWSPrefixedHTTProutes
IRWSBackendRoute
ApiService
DOMService.ts
DOMServiceInstance
DOMOutputType
DOMService
NotifyService.ts
NotifyServiceInstance
NotifyService
RoutingService.ts
RWSRouter
RoutingServiceInstance
IRoutingEvent
IRWSFrontRoutes
IRWSRouteResult
RouteReturn
RoutingService
_ROUTING_EVENT_NAME
renderRouteComponent
_service.ts
RWSService
UtilsService.ts
UtilsServiceInstance
UtilsService
WSService.ts
WSServiceInstance
IRWSWebsocketStatus
WSService
components
uploader
component.ts
RWSUploader
router
component.ts
RouterComponent
_attrs
angular-attr.ts
ngAttr
_component.ts
RWSViewComponent
IRWSAssetShowOptions
_decorator.ts
IRWSDecoratorOptions
RWSView
index.ts
registerRWSComponents
interfaces
IRWSConfig.ts
IRWSConfig
types
RWSNotify.ts
NotifyLogType
NotifyUiType
RWSNotify
index.ts
RWSClient
Generated using
TypeDoc