Skip to content

public.cachethq.component

Yoann Gini edited this page Sep 25, 2023 · 4 revisions

Function description

Introduced in Hello IT 1.4.1

Goal

This function is used to reflect the state of components provided by a Cachet HQ Server.

Settings

The settings dictionary contain all informations you can set to use this function. Here is a description of each.

Key Type Description
baseURL string Base URL for the Cachet HQ instance (like https://demo.cachethq.io)
stateSortScenario Integer (optional) Set the priority of unavailable over OK during state summarisation: 0; OK win over unavailable: 1. Default is 0

Sample settings

<dict>
	<key>functionIdentifier</key>
	<string>public.cachethq.component</string>
	<key>settings</key>
	<dict>
		<key>baseURL</key>
		<integer>https://cachethq.io</integer>
	</dict>
</dict>

More informations

Main implementation

The main implementation of this function is made in the CachetHQ plugin from the main project.