Class: QueryWorkflow

coresdk.workflow_activation.QueryWorkflow

Query a workflow

Implements

• IQueryWorkflow

Constructors

constructor

• new QueryWorkflow(properties?): QueryWorkflow

Constructs a new QueryWorkflow.

Parameters

Name	Type	Description
properties?	IQueryWorkflow	Properties to set

Returns

QueryWorkflow

Properties

arguments

• arguments: IPayload[]

QueryWorkflow arguments.

Implementation of

IQueryWorkflow.arguments

---

headers

• headers: Object

Headers attached to the query

Index signature

▪ [k: string]: IPayload

Implementation of

IQueryWorkflow.headers

---

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.

Implementation of

IQueryWorkflow.queryId

---

queryType

• queryType: string

The query's function/method/etc name

Implementation of

IQueryWorkflow.queryType

Methods

toJSON

▸ toJSON(): Object

Converts this QueryWorkflow to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): QueryWorkflow

Creates a new QueryWorkflow instance using the specified properties.

Parameters

Name	Type	Description
properties?	IQueryWorkflow	Properties to set

Returns

QueryWorkflow

QueryWorkflow instance

---

decode

▸ decode(reader, length?): QueryWorkflow

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

QueryWorkflow

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): QueryWorkflow

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

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	IQueryWorkflow	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	IQueryWorkflow	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

QueryWorkflow

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for QueryWorkflow

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

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