Class: DataQueryBuilder

Hierarchy

• BaseDataBuilder

• DataQueryBuilder

Implements

• IBuilder
• IDebuggable

Summary

Constructors

• constructor

Properties

Class Properties

Currently none in this class.

Inherited Properties

• STYLES_KEY

• _callback

• _context

• _data

• _excludedTypes

• _stylesCallback

Accessors

Class Accessors

• applyOption
• debugString
• expandOption
• filterOption
• hasApply
• hasExpand
• hasFilter
• hasMDKSearch
• hasOrderBy
• hasSearch
• hasSelect
• hasSkip
• hasSkipToken
• hasTop
• orderByOption
• originalQueryOptions
• searchOption
• selectOption
• skipOption
• skipTokenOption
• topOption
• userFilter
• userOrderBy

Inherited Accessors

• data

• doNotResolveKeys

• excludedTypes

• keepNullValue

Methods

Class Methods

• apply
• build
• expand
• filter
• filterTerm
• mdkSearch
• orderBy
• search
• select
• skip
• skipToken
• top

Inherited Methods

• deleteNullKeys

• setCallback

Object literals

Class Object literals

• systemQueryOptions

Inherited Object literals

Constructors

constructor

+ new DataQueryBuilder(context: IContext, queryOptions: string): DataQueryBuilder

Overrides void

Parameters:

Name	Type	Default
context	IContext	-
queryOptions	string	""

Returns: DataQueryBuilder

Accessors

applyOption

• applyOption:

---

debugString

• debugString:

---

expandOption

• expandOption:

---

filterOption

• filterOption:

---

hasApply

• hasApply:

---

hasExpand

• hasExpand:

---

hasFilter

• hasFilter:

---

hasMDKSearch

• hasMDKSearch:

---

hasOrderBy

• hasOrderBy:

---

hasSearch

• hasSearch:

---

hasSelect

• hasSelect:

---

hasSkip

• hasSkip:

---

hasSkipToken

• hasSkipToken:

---

hasTop

• hasTop:

---

orderByOption

• orderByOption:

---

originalQueryOptions

• originalQueryOptions:

---

searchOption

• searchOption:

---

selectOption

• selectOption:

---

skipOption

• skipOption:

---

skipTokenOption

• skipTokenOption:

---

topOption

• topOption:

---

userFilter

• userFilter:

---

userOrderBy

• userOrderBy:

Methods

apply

▸ apply(apply: string): this

Parameters:

Name	Type
apply	string

Returns: this

current DataQueryBuilder instance. It could be chained with other operators

---

build

▸ build(): Promise‹any›

Overrides void

Returns: Promise‹any›

Promise with the query string as result

---

expand

▸ expand(...expandOptions: string[]): this

Parameters:

Name	Type	Description
...expandOptions	string[]	a comma-separated list of strings

Returns: this

current DataQueryBuilder instance. It could be chained with other operators

---

filter

▸ filter(...terms: QueryOptionBuilder[] | string[]): FilterBuilder

Parameters:

Name	Type	Description
...terms	QueryOptionBuilder[] | string[]	a comma-separated list of FilterBuilder or string.

Returns: FilterBuilder

a FilterBuilder instance.

---

filterTerm

▸ filterTerm(...terms: FilterBuilder[] | string[]): FilterBuilder

Parameters:

Name	Type	Description
...terms	FilterBuilder[] | string[]	a comma-separated list of FilterBuilder or string

Returns: FilterBuilder

a FilterBuilder instance.

---

mdkSearch

▸ mdkSearch(searchString: string): QueryOptionBuilder

Parameters:

Name	Type	Description
searchString	string	seaerch string

Returns: QueryOptionBuilder

returns a MDKSearchBuilder instance

---

orderBy

▸ orderBy(...orderByOptions: string[]): this

Parameters:

Name	Type
...orderByOptions	string[]

Returns: this

---

search

▸ search(...terms: QueryOptionBuilder[] | string[]): SearchBuilder

Parameters:

Name	Type
...terms	QueryOptionBuilder[] | string[]

Returns: SearchBuilder

---

select

▸ select(...selectOptions: string[]): this

Parameters:

Name	Type	Description
...selectOptions	string[]	variadic arguments specified as comma-separated strings

Returns: this

current DataQueryBuilder instance. It could be chained with other operators

---

skip

▸ skip(skip: number | string): this

Parameters:

Name	Type
skip	number | string

Returns: this

current DataQueryBuilder instance. It could be chained with other operators

---

skipToken

▸ skipToken(skipToken: string): this

Parameters:

Name	Type
skipToken	string

Returns: this

current DataQueryBuilder instance. It could be chained with other operators

---

top

▸ top(top: number | string): this

Parameters:

Name	Type
top	number | string

Returns: this

current DataQueryBuilder instance. It could be chained with other operators

Object literals

Static systemQueryOptions

systemQueryOptions: object

Apply

• Apply: string = "apply"

Expand

• Expand: string = "expand"

Filter

• Filter: string = "filter"

OrderBy

• OrderBy: string = "orderby"

Search

• Search: string = "search"

Select

• Select: string = "select"

Skip

• Skip: string = "skip"

Top

• Top: string = "top"