AdminDataSource

Defined in: js-api/src/dapi.ts:503

Constructors

Constructor

new AdminDataSource(dart): AdminDataSource

Defined in: js-api/src/dapi.ts:506

Parameters

Parameter	Type
dart	any

Returns

AdminDataSource

Properties

Property	Type	Defined in
dart	any	js-api/src/dapi.ts:504

Methods

getMetrics()

getMetrics(options?): Promise<ServerMetrics>

Defined in: js-api/src/dapi.ts:519

Server metrics for a time window: HTTP request latency per route, the errors, the function-call queue, and database statistics. Needs the ViewTelemetry permission: without it, rejects with an Error whose status is 403. Sample: https://public.datagrok.ai/js/samples/dapi/admin

Parameters

Parameter	Type
options?	ServerMetricsOptions

Returns

Promise<ServerMetrics>

---

getProblem()

getProblem(id): Promise<Problem | null>

Defined in: js-api/src/dapi.ts:540

A problem the platform detected and its current alert, by id or kind:key; null when there is none. Needs the ManageAlerts permission: without it, rejects with an Error whose status is 403. Sample: https://public.datagrok.ai/js/samples/dapi/problems

Parameters

Parameter	Type
id	string

Returns

Promise<Problem | null>

---

getReportEmail()

getReportEmail(): Promise<string>

Defined in: js-api/src/dapi.ts:573

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:512

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:603

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(email): Promise<void>

Defined in: js-api/src/dapi.ts:580

Sends email

Parameters

Parameter	Type	Description
email	Email	message that will be sent using configured SMTP service

Returns

Promise<void>