Interface IDeliveryClient
Namespace: Noxum.Nova.Delivery.Client
Assembly: Noxum.Nova.Delivery.Client.dll
Syntax
public interface IDeliveryClientMethods
CountAsync(String, String, String, String, Nullable<Boolean>, System.Threading.CancellationToken)
Count objects
Declaration
System.Threading.Tasks.Task<ObjectCount> CountAsync(string branch, string lang = null, string variants = null, string filter = null, bool? deleted = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.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. |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectCount> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
CountTypedAsync(String, String, String, String, String, Nullable<Boolean>, System.Threading.CancellationToken)
Count typed objects
Declaration
System.Threading.Tasks.Task<ObjectCount> CountTypedAsync(string branch, string type, string lang = null, string variants = null, string filter = null, bool? deleted = null, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | type | The object type ID or ApiIdentifier |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.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. |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectCount> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetAsync(String, String, String, String, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ShowPropsMode>, System.Threading.CancellationToken)
Get a single scoped object
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | id | The object ID or ApiIdentifier |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.String | resolve | A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored. |
| System.Nullable<System.Int32> | resolveDepth | The maximum depth to resolve referred objects |
| System.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. |
| System.Nullable<System.Int32> | resolveReverseDepth | The maximum depth to resolve reverse references |
| System.Nullable<System.Boolean> | resolveUnits | Resolve units of measure |
| System.Nullable<System.Boolean> | deleted | Include deleted object |
| System.Nullable<ShowPropsMode> | props | Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none) |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectItem> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetBinaryAsync(Int32, System.Threading.CancellationToken)
Get a database binary by id
Declaration
System.Threading.Tasks.Task<FileResponse> GetBinaryAsync(int id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | The binary id |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FileResponse> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetBpoExternalBinaryAsync(String, String, System.Threading.CancellationToken)
Get an external binary (a file) by binary proxy object id
Declaration
System.Threading.Tasks.Task<FileResponse> GetBpoExternalBinaryAsync(string branch, string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | id | The binary proxy object ID or ApiIdentifier |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FileResponse> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetBpoThumbnailAsync(String, String, System.Threading.CancellationToken)
Get a thumbnail by binary proxy object id
Declaration
System.Threading.Tasks.Task<FileResponse> GetBpoThumbnailAsync(string branch, string id, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | id | The binary proxy object ID or ApiIdentifier |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FileResponse> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetBranchesAsync(System.Threading.CancellationToken)
Get the indexed branches
Declaration
System.Threading.Tasks.Task<ObjectList> GetBranchesAsync(System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectList> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetExternalBinaryAsync(String, System.Threading.CancellationToken)
Get an external binary (a file) by name
Declaration
System.Threading.Tasks.Task<FileResponse> GetExternalBinaryAsync(string name, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The file name of the external binary |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FileResponse> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetLanguagesAsync(String, System.Threading.CancellationToken)
Get the configured languages (i.e., UI languages, languages indexed for display names, langiages from configuration options and English)
Declaration
System.Threading.Tasks.Task<ObjectList> GetLanguagesAsync(string branch, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectList> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetTypedAsync(String, String, String, String, String, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ShowPropsMode>, System.Threading.CancellationToken)
Get a single typed and scoped object
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | type | The object type as an ID or ApiIdentifier |
| System.String | id | The object ID or ApiIdentifier |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.String | resolve | A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored. |
| System.Nullable<System.Int32> | resolveDepth | The maximum depth to resolve referred objects |
| System.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. |
| System.Nullable<System.Int32> | resolveReverseDepth | The maximum depth to resolve reverse references |
| System.Nullable<System.Boolean> | resolveUnits | Resolve units of measure |
| System.Nullable<System.Boolean> | deleted | Include deleted object |
| System.Nullable<ShowPropsMode> | props | Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none) |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectItem> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetTypesAsync(String, System.Threading.CancellationToken)
Get the configured object types
Declaration
System.Threading.Tasks.Task<ObjectList> GetTypesAsync(string branch, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectList> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
GetUpdateInfoAsync(String, System.Threading.CancellationToken)
Get index update information
Declaration
System.Threading.Tasks.Task<UpdateInfo> GetUpdateInfoAsync(string branch, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<UpdateInfo> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
ListAsync(String, String, String, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Boolean>, String, String, Nullable<Boolean>, Nullable<ShowPropsMode>, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Get a list of scoped objects.
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.String | resolve | A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored. |
| System.Nullable<System.Int32> | resolveDepth | The maximum depth to resolve referred objects |
| System.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. |
| System.Nullable<System.Int32> | resolveReverseDepth | The maximum depth to resolve reverse references |
| System.Nullable<System.Boolean> | resolveUnits | Resolve units of measure |
| System.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. |
| System.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 default sort order is by object ID. |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Nullable<ShowPropsMode> | props | Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none) |
| System.Nullable<System.Int32> | skip | Skip a number of items. Must not be negative. |
| System.Nullable<System.Int32> | take | Take this number of items. Must be in the range 1..1000 |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectList> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
ListTypedAsync(String, String, String, String, String, Nullable<Int32>, String, Nullable<Int32>, String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<ShowPropsMode>, Nullable<Int32>, Nullable<Int32>, System.Threading.CancellationToken)
Get a list of typed and scoped objects
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | type | The object type ID or ApiIdentifier |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.String | resolve | A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored. |
| System.Nullable<System.Int32> | resolveDepth | The maximum depth to resolve referred objects |
| System.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. |
| System.Nullable<System.Int32> | resolveReverseDepth | The maximum depth to resolve reverse references |
| System.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. |
| System.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 default sort order is by object ID. |
| System.Nullable<System.Boolean> | resolveUnits | Resolve units of measure |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Nullable<ShowPropsMode> | props | Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none) |
| System.Nullable<System.Int32> | skip | Skip a number of items. Must not be negative. |
| System.Nullable<System.Int32> | take | Take this number of items. Must be in the range 1..1000 |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ObjectList> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
OccurrencesAsync(String, String, String, String, String, String, Nullable<Int32>, Nullable<Boolean>, Nullable<ShowPropsMode>, Nullable<Int32>, System.Threading.CancellationToken)
Get occurrences for a list of fields that may be used for facet filtering
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | fields | A comma separated list of field names |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.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. |
| System.String | resolve | A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored. |
| System.Nullable<System.Int32> | resolveDepth | The maximum depth to resolve referred objects |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Nullable<ShowPropsMode> | props | Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none) |
| System.Nullable<System.Int32> | take | Take this number of items. Must be in the range 1..1000 |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OccurrencesResult> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
OccurrencesTypedAsync(String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Boolean>, Nullable<ShowPropsMode>, Nullable<Int32>, System.Threading.CancellationToken)
Get occurrences for a particular object type and a list of fields that may be used for facet filtering.
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | type | The object type ID or ApiIdentifier |
| System.String | fields | A comma separated list of field names |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.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. |
| System.String | resolve | A comma separated list of ApiIdentifiers attributes to be resolved and returned in a "refs" list. Wrong ApiIdentifiers are ignored. |
| System.Nullable<System.Int32> | resolveDepth | The maximum depth to resolve referred objects |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Nullable<ShowPropsMode> | props | Mode to show properties (0 = configured by ObjectTypeApiAttributes, 1 = all with API identifiers, 2 = none) |
| System.Nullable<System.Int32> | take | Take this number of items. Must be in the range 1..1000 |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OccurrencesResult> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
SuggestionsAsync(String, String, String, String, String, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, Nullable<Int32>, System.Threading.CancellationToken)
Get a list of suggestions for a search pattern that may be used for type-ahead
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | pattern | The search pattern |
| System.String | fields | A comma separated list of field names |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.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. |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Nullable<System.Int32> | take | Take this number of items. Must be in the range 1..1000 |
| System.Nullable<System.Boolean> | sortByValue | If true, suggestions are sorted by value and not by count |
| System.Nullable<System.Boolean> | analyze | If true, the search pattern is analyzed, otherwise it must occur as a prefix. |
| System.Nullable<System.Boolean> | fuzzy | If true, the last search term is used as a fuzzy pattern, not as a prefix. |
| System.Nullable<System.Single> | fuzzyMinSimilarity | Minimum similarity for fuzzy search. The default value is 0.5. If fuzzy=false, this value is ignored |
| System.Nullable<System.Int32> | fuzzyPrefixLength | The prefix length for fuzzy search. The default value is 0. If fuzzy=false, this value is ignored |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SuggestionsResult> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |
SuggestionsTypedAsync(String, String, String, String, String, String, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, Nullable<Int32>, System.Threading.CancellationToken)
Get a list of suggestions for a search pattern and a particular object type that may be used for type-ahead
Declaration
System.Threading.Tasks.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, System.Threading.CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | branch | The branch ID or ApiIdentifier |
| System.String | type | The object type ID or ApiIdentifier |
| System.String | pattern | The search pattern |
| System.String | fields | A comma separated list of field names |
| System.String | lang | The localization language as an ID or a culture name |
| System.String | variants | A comma separated list of variant IDs or ApiIdentifiers |
| System.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. |
| System.Nullable<System.Boolean> | deleted | Include deleted objects |
| System.Nullable<System.Int32> | take | Take this number of items. Must be in the range 1..1000 |
| System.Nullable<System.Boolean> | sortByValue | If true, suggestions are sorted by value and not by count |
| System.Nullable<System.Boolean> | analyze | If true, the search pattern is analyzed, otherwise it must occur as a prefix. |
| System.Nullable<System.Boolean> | fuzzy | If true, the last search term is used as a fuzzy pattern, not as a prefix. |
| System.Nullable<System.Single> | fuzzyMinSimilarity | Minimum similarity for fuzzy search. The default value is 0.5. If fuzzy=false, this value is ignored |
| System.Nullable<System.Int32> | fuzzyPrefixLength | The prefix length for fuzzy search. The default value is 0. If fuzzy=false, this value is ignored |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SuggestionsResult> | OK |
Exceptions
| Type | Condition |
|---|---|
| DeliveryApiException | A server side error occurred. |