AdminDataSource
Defined in: js-api/src/dapi.ts:492
Constructors
Constructor
new AdminDataSource(
dart):AdminDataSource
Defined in: js-api/src/dapi.ts:495
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
AdminDataSource
Properties
| Property | Type | Defined in |
|---|---|---|
dart | any | js-api/src/dapi.ts:493 |
Methods
getMetrics()
getMetrics(
options?):Promise<ServerMetrics>
Defined in: js-api/src/dapi.ts:507
Server metrics for a time window: HTTP request latency per route, the function-call queue, and database statistics. Admin only. Sample: https://public.datagrok.ai/js/samples/dapi/admin
Parameters
| Parameter | Type |
|---|---|
options? | ServerMetricsOptions |
Returns
Promise<ServerMetrics>
getReportEmail()
getReportEmail():
Promise<string>
Defined in: js-api/src/dapi.ts:526
Returns the configured report email address from admin settings. Used as the default recipient for error reports and admin notifications.
Returns
Promise<string>
getServiceInfos()
getServiceInfos():
Promise<ServiceInfo[]>
Defined in: js-api/src/dapi.ts:501
Returns information about the services. Sample: https://public.datagrok.ai/js/samples/dapi/admin
Returns
Promise<ServiceInfo[]>
pushMessage()
pushMessage(
messageType,message,sessionIds):Promise<any>
Defined in: js-api/src/dapi.ts:556
Sends a message to the specified browser client See also ServerMessageTypes
Parameters
| Parameter | Type |
|---|---|
messageType | string |
message | object |
sessionIds | string[] |
Returns
Promise<any>
sendEmail()
sendEmail(
Promise<void>
Defined in: js-api/src/dapi.ts:533
Sends email
Parameters
| Parameter | Type | Description |
|---|---|---|
email | Email | message that will be sent using configured SMTP service |
Returns
Promise<void>