Function: event.Reset

Send a reset command directly to the Extension, which is responsible for the given Event. This requires the Extension to support the command.

Requires AOP API version wg 0.4.10 or later.

Syntax

{
	"method": "event.Reset",
	"params": {
		"id": "...",
		"all": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Reset( AdvGuid id, bool all );
public Task<bool> ResetAsync(Guid id, bool all, CancellationToken ct = default);
reset(id: string, all: boolean): Promise<boolean>;

Parameters

id : guid

The Event’s id.

all : bool

Indicates if all open Events of the responsible Extension should be reset or just the referenced Event.

Result : bool

True if successful.

Errors

Data.NotFound

The requested data was not found or the caller does not have the required permission to access it. For additional information, see Data.NotFound.

Data.Forbidden

The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.

Remarks

This method requires API control access.