Function: file.Get

Returns a filtered list of FileInfo Objects.

Syntax

{
	"method": "file.Get",
	"params": {
		"filter": "...",
		"select": "...",
		"limit": "...",
		"offset": "...",
		"scroll": "...",
		"context": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<GetResult<FileInfo>> Get( std::optional<AdvString> filter = std::nullopt
	 std::optional<std::vector<AdvString>> select = std::nullopt,
	 std::optional<int> limit = std::nullopt,
	 std::optional<int> offset = std::nullopt,
	 std::optional<EnumPaginationScroll> scroll = std::nullopt,
	 std::optional<AdvString> context = std::nullopt );
public Task<GetResult<FileInfo>> GetAsync(string? filter = null,
		long? limit = null,
		long? offset = null,
		EnumPaginationScroll? scroll = null,
		string? context = null,
		CancellationToken ct = default);
get(filter?: string | undefined, limit?: number | undefined, offset?: number | undefined, scroll?: EnumPaginationScroll | undefined, context?: string | undefined): Promise<GetResultFileInfo>;

Parameters

filter : string optional

Filter expression which determines the result set.

select : string[] optional

List of properties that should be contained in the result objects.

limit : int optional

Maximum amount of Objects that should be returned.

offset : int optional

Offset of the first Object in the result set that should be returned. Used for direct pagination.

scroll : int (EnumPaginationScroll) optional

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

context : string optional

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

Result : GetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidFilterExpression ≥wg 0.5.1

The provided filter expression has invalid syntax.

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.