Interface IDeliveryClient

Namespace: Noxum.Nova.Delivery.Client

Assembly: Noxum.Nova.Delivery.Client.dll

Syntax

public interface IDeliveryClient

Methods

CountAsync(string, string, string, string, bool?, CancellationToken)

Count objects

Declaration

Task<ObjectCount> CountAsync(string branch, string lang = null, string variants = null, string filter = null, bool? deleted = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
bool?	deleted	Include deleted objects
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectCount>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

CountTypedAsync(string, string, string, string, string, bool?, CancellationToken)

Count typed objects

Declaration

Task<ObjectCount> CountTypedAsync(string branch, string type, string lang = null, string variants = null, string filter = null, bool? deleted = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	type	The object type ID or ApiIdentifier
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
bool?	deleted	Include deleted objects
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectCount>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetAsync(string, string, string, string, string, int?, string, int?, bool?, bool?, ShowPropsMode?, CancellationToken)

Get a single scoped object

Declaration

Task<ObjectItem> GetAsync(string branch, string id, string lang = null, string variants = null, string resolve = null, int? resolveDepth = null, string resolveReverse = null, int? resolveReverseDepth = null, bool? resolveUnits = null, bool? deleted = null, ShowPropsMode? props = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	id	The object ID or ApiIdentifier
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	resolve	A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveDepth	The maximum depth to resolve referred objects
string	resolveReverse	A comma separated list of ApiIdentifiers attributes to be resolved reverse. IDs of reverse relations are delivered in the "reverse" property and objects are returned in the "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveReverseDepth	The maximum depth to resolve reverse references
bool?	resolveUnits	Resolve units of measure
bool?	deleted	Include deleted object
ShowPropsMode?	props	Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none)
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectItem>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetBinaryAsync(int, CancellationToken)

Get a database binary by id

Declaration

Task<FileResponse> GetBinaryAsync(int id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	id	The binary id
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetBpoExternalBinaryAsync(string, string, CancellationToken)

Get an external binary (a file) by binary proxy object id

Declaration

Task<FileResponse> GetBpoExternalBinaryAsync(string branch, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	id	The binary proxy object ID or ApiIdentifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetBpoThumbnailAsync(string, string, CancellationToken)

Get a thumbnail by binary proxy object id

Declaration

Task<FileResponse> GetBpoThumbnailAsync(string branch, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	id	The binary proxy object ID or ApiIdentifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetBranchesAsync(CancellationToken)

Get the indexed branches

Declaration

Task<ObjectList> GetBranchesAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectList>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetExternalBinaryAsync(string, CancellationToken)

Get an external binary (a file) by name

Declaration

Task<FileResponse> GetExternalBinaryAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The file name of the external binary
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<FileResponse>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetLanguagesAsync(string, CancellationToken)

Get the configured languages (i.e., UI languages, languages indexed for display names, langiages from configuration options and English)

Declaration

Task<ObjectList> GetLanguagesAsync(string branch, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectList>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetTypedAsync(string, string, string, string, string, string, int?, string, int?, bool?, bool?, ShowPropsMode?, CancellationToken)

Get a single typed and scoped object

Declaration

Task<ObjectItem> GetTypedAsync(string branch, string type, string id, string lang = null, string variants = null, string resolve = null, int? resolveDepth = null, string resolveReverse = null, int? resolveReverseDepth = null, bool? resolveUnits = null, bool? deleted = null, ShowPropsMode? props = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	type	The object type as an ID or ApiIdentifier
string	id	The object ID or ApiIdentifier
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	resolve	A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveDepth	The maximum depth to resolve referred objects
string	resolveReverse	A comma separated list of ApiIdentifiers attributes to be resolved reverse. IDs of reverse relations are delivered in the "reverse" property and objects are returned in the "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveReverseDepth	The maximum depth to resolve reverse references
bool?	resolveUnits	Resolve units of measure
bool?	deleted	Include deleted object
ShowPropsMode?	props	Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none)
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectItem>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetTypesAsync(string, CancellationToken)

Get the configured object types

Declaration

Task<ObjectList> GetTypesAsync(string branch, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectList>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

GetUpdateInfoAsync(string, CancellationToken)

Get index update information

Declaration

Task<UpdateInfo> GetUpdateInfoAsync(string branch, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<UpdateInfo>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

ListAsync(string, string, string, string, int?, string, int?, bool?, string, string, bool?, ShowPropsMode?, int?, int?, CancellationToken)

Get a list of scoped objects.

Declaration

Task<ObjectList> ListAsync(string branch, string lang = null, string variants = null, string resolve = null, int? resolveDepth = null, string resolveReverse = null, int? resolveReverseDepth = null, bool? resolveUnits = null, string filter = null, string sort = null, bool? deleted = null, ShowPropsMode? props = null, int? skip = null, int? take = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	resolve	A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveDepth	The maximum depth to resolve referred objects
string	resolveReverse	A comma separated list of ApiIdentifiers attributes to be resolved reverse. IDs of reverse relations are delivered in the "reverse" property and objects are returned in the "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveReverseDepth	The maximum depth to resolve reverse references
bool?	resolveUnits	Resolve units of measure
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
string	sort	A comma separated list of attribute IDs or ApiIdentifiers used as sort criteria. 'asc' or 'desc' can be used as an additional keyword to set the sort order. The special value "$score" can also be used for sorting, which sorts by score. The default sort order is by object ID.
bool?	deleted	Include deleted objects
ShowPropsMode?	props	Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none)
int?	skip	Skip a number of items. Must not be negative.
int?	take	Take this number of items. Must be in the range 1..1000
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectList>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

ListTypedAsync(string, string, string, string, string, int?, string, int?, string, string, bool?, bool?, ShowPropsMode?, int?, int?, CancellationToken)

Get a list of typed and scoped objects

Declaration

Task<ObjectList> ListTypedAsync(string branch, string type, string lang = null, string variants = null, string resolve = null, int? resolveDepth = null, string resolveReverse = null, int? resolveReverseDepth = null, string filter = null, string sort = null, bool? resolveUnits = null, bool? deleted = null, ShowPropsMode? props = null, int? skip = null, int? take = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	type	The object type ID or ApiIdentifier
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	resolve	A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveDepth	The maximum depth to resolve referred objects
string	resolveReverse	A comma separated list of ApiIdentifiers attributes to be resolved reverse. IDs of reverse relations are delivered in the "reverse" property and objects are returned in the "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveReverseDepth	The maximum depth to resolve reverse references
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
string	sort	A comma separated list of attribute IDs or ApiIdentifiers used as sort criteria. 'asc' or 'desc' can be used as an additional keyword to set the sort order. The special value "$score" can also be used for sorting, which sorts by score. The default sort order is by object ID.
bool?	resolveUnits	Resolve units of measure
bool?	deleted	Include deleted objects
ShowPropsMode?	props	Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none)
int?	skip	Skip a number of items. Must not be negative.
int?	take	Take this number of items. Must be in the range 1..1000
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectList>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

OccurrencesAsync(string, string, string, string, string, string, int?, bool?, ShowPropsMode?, int?, CancellationToken)

Get occurrences for a list of fields that may be used for facet filtering

Declaration

Task<OccurrencesResult> OccurrencesAsync(string branch, string fields, string lang = null, string variants = null, string filter = null, string resolve = null, int? resolveDepth = null, bool? deleted = null, ShowPropsMode? props = null, int? take = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	fields	A comma separated list of field names
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
string	resolve	A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveDepth	The maximum depth to resolve referred objects
bool?	deleted	Include deleted objects
ShowPropsMode?	props	Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none)
int?	take	Take this number of items. Must be in the range 1..1000
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<OccurrencesResult>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

OccurrencesTypedAsync(string, string, string, string, string, string, string, int?, bool?, ShowPropsMode?, int?, CancellationToken)

Get occurrences for a particular object type and a list of fields that may be used for facet filtering.

Declaration

Task<OccurrencesResult> OccurrencesTypedAsync(string branch, string type, string fields, string lang = null, string variants = null, string filter = null, string resolve = null, int? resolveDepth = null, bool? deleted = null, ShowPropsMode? props = null, int? take = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	type	The object type ID or ApiIdentifier
string	fields	A comma separated list of field names
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
string	resolve	A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored.
int?	resolveDepth	The maximum depth to resolve referred objects
bool?	deleted	Include deleted objects
ShowPropsMode?	props	Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none)
int?	take	Take this number of items. Must be in the range 1..1000
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<OccurrencesResult>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

SuggestionsAsync(string, string, string, string, string, string, bool?, int?, bool?, bool?, bool?, float?, int?, CancellationToken)

Get a list of suggestions for a search pattern that may be used for type-ahead

Declaration

Task<SuggestionsResult> SuggestionsAsync(string branch, string pattern, string fields, string lang = null, string variants = null, string filter = null, bool? deleted = null, int? take = null, bool? sortByValue = null, bool? analyze = null, bool? fuzzy = null, float? fuzzyMinSimilarity = null, int? fuzzyPrefixLength = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	pattern	The search pattern
string	fields	A comma separated list of field names
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
bool?	deleted	Include deleted objects
int?	take	Take this number of items. Must be in the range 1..1000
bool?	sortByValue	If true, suggestions are sorted by value and not by count
bool?	analyze	If true, the search pattern is analyzed, otherwise it must occur as a prefix.
bool?	fuzzy	If true, the last search term is used as a fuzzy pattern, not as a prefix.
float?	fuzzyMinSimilarity	Minimum similarity for fuzzy search. The default value is 0.5. If fuzzy=false, this value is ignored
int?	fuzzyPrefixLength	The prefix length for fuzzy search. The default value is 0. If fuzzy=false, this value is ignored
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<SuggestionsResult>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.

SuggestionsTypedAsync(string, string, string, string, string, string, string, bool?, int?, bool?, bool?, bool?, float?, int?, CancellationToken)

Get a list of suggestions for a search pattern and a particular object type that may be used for type-ahead

Declaration

Task<SuggestionsResult> SuggestionsTypedAsync(string branch, string type, string pattern, string fields, string lang = null, string variants = null, string filter = null, bool? deleted = null, int? take = null, bool? sortByValue = null, bool? analyze = null, bool? fuzzy = null, float? fuzzyMinSimilarity = null, int? fuzzyPrefixLength = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	type	The object type ID or ApiIdentifier
string	pattern	The search pattern
string	fields	A comma separated list of field names
string	lang	The localization language as an ID or a culture name
string	variants	A comma separated list of variant IDs or ApiIdentifiers
string	filter	A list of filter conditions joined with the AND operator '&&'. A condition is build from an ApiIdentifier, a compare operator (=, !=, <, >, <=, >=, :) and a value. Prefix with 'meta.' to access meta data.
bool?	deleted	Include deleted objects
int?	take	Take this number of items. Must be in the range 1..1000
bool?	sortByValue	If true, suggestions are sorted by value and not by count
bool?	analyze	If true, the search pattern is analyzed, otherwise it must occur as a prefix.
bool?	fuzzy	If true, the last search term is used as a fuzzy pattern, not as a prefix.
float?	fuzzyMinSimilarity	Minimum similarity for fuzzy search. The default value is 0.5. If fuzzy=false, this value is ignored
int?	fuzzyPrefixLength	The prefix length for fuzzy search. The default value is 0. If fuzzy=false, this value is ignored
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<SuggestionsResult>	OK

Exceptions

Type	Condition
DeliveryApiException	A server side error occurred.