Skip to main content

Class: SilentTelemetryConnector

Class for performing telemetry operations to nowhere.

Implements​

Constructors​

Constructor​

new SilentTelemetryConnector(): SilentTelemetryConnector

Returns​

SilentTelemetryConnector

Properties​

NAMESPACE​

readonly static NAMESPACE: string = "silent"

The namespace for the class.

CLASS_NAME​

readonly static CLASS_NAME: string

Runtime name for the class.

Methods​

className()​

className(): string

Returns the class name of the component.

Returns​

string

The class name of the component.

Implementation of​

ITelemetryConnector.className

createMetric()​

createMetric(metric): Promise<void>

Create one or more metrics.

Parameters​

metric​

ITelemetryMetric | ITelemetryMetric[]

The metric details, or the details of several metrics.

Returns​

Promise<void>

A promise that resolves when the metric has been created.

Implementation of​

ITelemetryConnector.createMetric

updateMetric()​

updateMetric(metric): Promise<void>

Update metric.

Parameters​

metric​

Omit<ITelemetryMetric, "type">

The metric details.

Returns​

Promise<void>

A promise that resolves when the metric has been updated.

Implementation of​

ITelemetryConnector.updateMetric

addMetricValue()​

addMetricValue(id, value, customData?): Promise<string>

Update metric value.

Parameters​

id​

string

The id of the metric.

value​

number | MetricCounterOperation

The value for the update operation.

customData?​

The custom data for the update operation.

Returns​

Promise<string>

The created metric value id.

Implementation of​

ITelemetryConnector.addMetricValue

addMetricValues()​

addMetricValues(values): Promise<string[]>

Add multiple metric values.

Parameters​

values​

ITelemetryMetricValueEntry[]

The metric values to add.

Returns​

Promise<string[]>

The created metric value ids.

Implementation of​

ITelemetryConnector.addMetricValues

removeMetric()​

removeMetric(id): Promise<void>

Remove metric.

Parameters​

id​

string

The id of the metric.

Returns​

Promise<void>

A promise that resolves when the metric and all its values have been removed.

Implementation of​

ITelemetryConnector.removeMetric