Class: TargetProxy¶
TargetProxy is a developer-facing class that provides access to a target. It is passed to rules to provide access to a target for application specific customizations
Hierarchy¶
-
TargetProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
- _entitySet
- _function
- _outputPath
- _path
- _queryOptions
- _readLink
- _requestProperties
- _serverSidePaging
- _service
- _specifier
Inherited Properties¶
Currently none inherited from the parent class(es).
Accessors¶
Class Accessors¶
Inherited Accessors¶
Currently none inherited from the parent class(es).
Methods¶
Class Methods¶
- getEntitySet
- getFunction
- getOutputPath
- getPath
- getQueryOptions
- getReadLink
- getRequestProperties
- getServerSidePaging
- getService
- setEntitySet
- setFunction
- setOutputPath
- setPath
- setQueryOptions
- setReadLink
- setRequestProperties
- setServerSidePaging
- setService
Inherited Methods¶
Currently none inherited from the parent class(es).
Constructors¶
constructor¶
+ new TargetProxy(specifier: any): TargetProxy
Parameters:
| Name | Type |
|---|---|
specifier |
any |
Returns: TargetProxy
Properties¶
Protected _entitySet¶
• _entitySet: string
Protected _function¶
• _function: any
Protected _outputPath¶
• _outputPath: string
Protected _path¶
• _path: string
Protected _queryOptions¶
• _queryOptions: string
Protected _readLink¶
• _readLink: string
Protected _requestProperties¶
• _requestProperties: any
Protected _serverSidePaging¶
• _serverSidePaging: boolean = false
Protected _service¶
• _service: string
Protected _specifier¶
• _specifier: any
Accessors¶
specifier¶
• getter
Get the specifier of the target
Returns: any
Methods¶
getEntitySet¶
▸ getEntitySet(): string
Implementation of ITargetProxy
Get the entity set name
Returns: string
getFunction¶
▸ getFunction(): any
Implementation of ITargetProxy
Get the function object in {Name: string, Parameters?: {key: string, value: any}} format
Returns: any
getOutputPath¶
▸ getOutputPath(): string
Implementation of ITargetProxy
Get the Outputpath
Returns: string
getPath¶
▸ getPath(): string
Implementation of ITargetProxy
Get the Path
Returns: string
getQueryOptions¶
▸ getQueryOptions(): string
Implementation of ITargetProxy
Get the QueryOptions
Returns: string
getReadLink¶
▸ getReadLink(): string
Implementation of ITargetProxy
Get the ReadLink
Returns: string
getRequestProperties¶
▸ getRequestProperties(): string
Implementation of ITargetProxy
Get the RequestProperties
Returns: string
getServerSidePaging¶
▸ getServerSidePaging(): boolean
Implementation of ITargetProxy
Get the ServerSidePaging
Returns: boolean
getService¶
▸ getService(): string
Implementation of ITargetProxy
Get the Service name
Returns: string
setEntitySet¶
▸ setEntitySet(value: string): this
Implementation of ITargetProxy
Set the EntitySet for the Target
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | the EntitySet name |
Returns: this
this, can be chained
setFunction¶
▸ setFunction(value: any): this
Implementation of ITargetProxy
Set the Target Function
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | the function object in |
Returns: this
this, can be chained
setOutputPath¶
▸ setOutputPath(value: string): this
Implementation of ITargetProxy
Set the Target OutputPath
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | web client target output path |
Returns: this
this, can be chained
setPath¶
▸ setPath(value: string): this
Implementation of ITargetProxy
Set the Target Path
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | web client target path |
Returns: this
this, can be chained
setQueryOptions¶
▸ setQueryOptions(value: string): this
Implementation of ITargetProxy
Set the Target QueryOptions
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | query string |
Returns: this
this, can be chained
setReadLink¶
▸ setReadLink(value: string): this
Implementation of ITargetProxy
Set the Target ReadLink
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | query string |
Returns: this
this, can be chained
setRequestProperties¶
▸ setRequestProperties(value: any): this
Implementation of ITargetProxy
set the Target RequestProperties
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | web client requestProperties |
Returns: this
this, can be chained
setServerSidePaging¶
▸ setServerSidePaging(value: boolean): this
Implementation of ITargetProxy
Set the Target ServerSidePaging value
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | boolean value for if server supports ServerSidePaging(skiptoken) for pagination |
Returns: this
this, can be chained
setService¶
▸ setService(value: string): this
Implementation of ITargetProxy
Set the Target Service name
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | service name |
Returns: this
this, can be chained