Function: ext.log.Add

Adds a new entry to the extension log. Only information concerning the functionality of the Extension should be logged here. Entries regarding communication with the third-party system belong in the IO log. Changes to States/Events/Activities are automatically logged to the extension log by the host.

Syntax

{
	"method": "ext.log.Add",
	"params": {
		"url": "...",
		"text": "...",
		"type": "...",
		"props": "...",
		"time": "...",
		"iotag": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<void> LogAdd( AdvString text
	 std::optional<AdvString> url = std::nullopt,
	 std::optional<EnumExtLogType> type = std::nullopt,
	 std::optional<AdvObject> props = std::nullopt,
	 std::optional<AdvTime> time = std::nullopt,
	 std::optional<AdvString> iotag = std::nullopt );
public Task LogAddAsync(string text,
		string? url = null,
		EnumExtLogType? type = null,
		IDictionary<string,
		object?>? props = null,
		DateTime? time = null,
		string? iotag = null,
		CancellationToken ct = default);
logAdd(text: string, url?: string | undefined, type?: EnumExtLogType | undefined, props?: Map<string, Object> | undefined, time?: Date | undefined, iotag?: string | undefined): Promise<>;

Parameters

url : string optional

The parameter value is AopUrl.

URL of the Object the log entry is related to.

text : string

The message to be logged. This can be an LNG string.

type : int (EnumExtLogType) optional

Type of log entry.

props : value{} optional

The parameter key is Symbol.

Additional properties. These are used to translate the log text if it is an LNG string.

time : time optional

Time that the log entry should have. If not set, the current time will be used.

iotag : string optional

Tag for association to IO log entries or Events.

Result : void