Function: event.Get ➁

Returns a filtered list of Event Objects.

Syntax

{
	"method": "event.Get",
	"params": {
		"scroll": "...",
		"context": "...",
		"limit": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<GetResult<Event>> Get( EnumPaginationScroll scroll, AdvString context, std::optional<int> limit = std::nullopt );
public Task<GetResult<Event>> GetAsync(EnumPaginationScroll scroll,
		string context,
		long? limit = null,
		CancellationToken ct = default);
getNext(scroll: EnumPaginationScroll, context: string, limit?: number | undefined): Promise<GetResultEvent>;

Parameters

scroll : int (EnumPaginationScroll)

Scrolls through the result set with ‘Next’ or ‘Prev’. Used for pagination.

context : string

The context received within the last get result. Mandatory for subsequent get calls with pagination.

limit : int optional

Maximum amount of Objects that should be returned.

Result : GetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidContext ≥wg 0.5.1

The provided context cannot be used for pagination.

Data.InvalidCursor ≥wg 0.5.1

The object referenced by the context cursor has been deleted. The entire pagination process needs to be restarted.

Remarks

This method requires API read access.