isopruefi-frontend / api/api-client / TopicClient

Class: TopicClient¶

Defined in: api/api-client.ts:422

Constructors¶

Constructor¶

new TopicClient(baseUrl?, http?): TopicClient

Defined in: api/api-client.ts:427

Parameters¶

baseUrl?¶

string

http?¶

fetch¶

Returns¶

TopicClient

Properties¶

jsonParseReviver¶

protected jsonParseReviver: undefined | (key, value) => any = undefined

Defined in: api/api-client.ts:425

Methods¶

createTopic()¶

createTopic(topicSetting): Promise\<any>

Defined in: api/api-client.ts:563

Creates a new MQTT topic configuration for sensor monitoring.

Parameters¶

topicSetting¶

TopicSetting

The complete topic setting configuration to create.

Returns¶

Promise\<any>

Topic setting created successfully. Returns the new topic ID.

deleteTopic()¶

deleteTopic(topicSetting): Promise\<any>

Defined in: api/api-client.ts:701

Deletes an existing MQTT topic setting from the system.

Parameters¶

topicSetting¶

TopicSetting

The topic setting object identifying the configuration to delete.

Returns¶

Promise\<any>

Successfully deleted the topic setting.

getAllSensorTypes()¶

getAllSensorTypes(): Promise\<string[]>

Defined in: api/api-client.ts:499

Retrieves all available sensor types from the system.

Returns¶

Promise\<string[]>

Successfully retrieved the list of sensor types.

getAllTopics()¶

getAllTopics(): Promise\<TopicSetting[]>

Defined in: api/api-client.ts:436

Retrieves all configured MQTT topic settings from the system.

Returns¶

Promise\<TopicSetting[]>

Successfully retrieved all topic settings.

processCreateTopic()¶

protected processCreateTopic(response): Promise\<any>

Defined in: api/api-client.ts:583

Parameters¶

response¶

Response

Returns¶

Promise\<any>

processDeleteTopic()¶

protected processDeleteTopic(response): Promise\<any>

Defined in: api/api-client.ts:721

Parameters¶

response¶

Response

Returns¶

Promise\<any>

processGetAllSensorTypes()¶

protected processGetAllSensorTypes(response): Promise\<string[]>

Defined in: api/api-client.ts:515

Parameters¶

response¶

Response

Returns¶

Promise\<string[]>

processGetAllTopics()¶

protected processGetAllTopics(response): Promise\<TopicSetting[]>

Defined in: api/api-client.ts:452

Parameters¶

response¶

Response

Returns¶

Promise\<TopicSetting[]>

processUpdateTopic()¶

protected processUpdateTopic(response): Promise\<any>

Defined in: api/api-client.ts:652

Parameters¶

response¶

Response

Returns¶

Promise\<any>

updateTopic()¶

updateTopic(topicSetting): Promise\<any>

Defined in: api/api-client.ts:632

Updates an existing MQTT topic setting in the system.

Parameters¶

topicSetting¶

TopicSetting

The topic setting object containing updated configuration.

Returns¶

Promise\<any>

Successfully updated the topic setting.