Class: QueryWorkflow
coresdk.workflow_activation.QueryWorkflow
Query a workflow
Properties
arguments
• arguments: $Properties[]
QueryWorkflow arguments.
headers
• headers: Object
Headers attached to the query
Index signature
▪ [k: string]: $Properties
queryId
• queryId: string
For PollWFTResp query field, this will be set to the special value legacy. For the
queries field, the server provides a unique identifier. If it is a legacy query,
lang cannot issue any commands in response other than to answer the query.
queryType
• queryType: string
The query's function/method/etc name
Methods
toJSON
▸ toJSON(): Object
Converts this QueryWorkflow to JSON.
Returns
Object
JSON object
create
▸ create(properties?): QueryWorkflow & $Properties
Creates a new QueryWorkflow instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
QueryWorkflow instance
▸ create(properties?): QueryWorkflow
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): QueryWorkflow & $Properties
Decodes a QueryWorkflow message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
QueryWorkflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): QueryWorkflow & $Properties
Decodes a QueryWorkflow message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
QueryWorkflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified QueryWorkflow message. Does not implicitly coresdk.workflow_activation.QueryWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | QueryWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified QueryWorkflow message, length delimited. Does not implicitly coresdk.workflow_activation.QueryWorkflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | QueryWorkflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): QueryWorkflow
Creates a QueryWorkflow message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
QueryWorkflow
toObject
▸ toObject(message, options?): Object
Creates a plain object from a QueryWorkflow message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | QueryWorkflow | QueryWorkflow |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object