Skip to main content

Class: 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()​

Call Signature​

static create(properties?): QueryWorkflow & $Properties

Creates a new QueryWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

QueryWorkflow & $Properties

QueryWorkflow instance

Call Signature​

static create(properties?): QueryWorkflow

Creates a new QueryWorkflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

QueryWorkflow

QueryWorkflow instance

decode()​

static decode(reader, length?): QueryWorkflow & $Properties

Decodes a QueryWorkflow message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

QueryWorkflow & $Properties

QueryWorkflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): QueryWorkflow & $Properties

Decodes a QueryWorkflow message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

QueryWorkflow & $Properties

QueryWorkflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified QueryWorkflow message. Does not implicitly coresdk.workflow_activation.QueryWorkflow.verify|verify messages.

Parameters​

message​

$Properties

QueryWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified QueryWorkflow message, length delimited. Does not implicitly coresdk.workflow_activation.QueryWorkflow.verify|verify messages.

Parameters​

message​

$Properties

QueryWorkflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): QueryWorkflow

Creates a QueryWorkflow message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

QueryWorkflow

QueryWorkflow

toObject()​

static toObject(message, options?): object

Creates a plain object from a QueryWorkflow message. Also converts values to other types if specified.

Parameters​

message​

QueryWorkflow

QueryWorkflow

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object