Skip to main content

Class: QueryWorkflow

coresdk.workflow_activation.QueryWorkflow

Query a workflow

Implements#

Constructors#

constructor#

new QueryWorkflow(properties?)

Constructs a new QueryWorkflow.

Parameters#

NameType
properties?IQueryWorkflow

Properties#

arguments#

arguments: IPayload[]

QueryWorkflow arguments.

Implementation of#

IQueryWorkflow.arguments


queryId#

queryId: string

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


decode#

Static decode(reader, length?): QueryWorkflow

Decodes a QueryWorkflow message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

QueryWorkflow

QueryWorkflow


decodeDelimited#

Static decodeDelimited(reader): QueryWorkflow

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

QueryWorkflow

QueryWorkflow


encode#

Static encode(message, writer?): Writer

Encodes the specified QueryWorkflow message. Does not implicitly {@link coresdk.workflow_activation.QueryWorkflow.verify|verify} messages.

Parameters#

NameTypeDescription
messageIQueryWorkflowQueryWorkflow message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIQueryWorkflowQueryWorkflow message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageQueryWorkflowQueryWorkflow
options?IConversionOptions-

Returns#

Object

Plain object