Skip to main content

Class: QuerySuccess

coresdk.workflow_commands.QuerySuccess

Represents a QuerySuccess.

Implements#

Constructors#

constructor#

new QuerySuccess(properties?)

Constructs a new QuerySuccess.

Parameters#

NameType
properties?IQuerySuccess

Properties#

response#

Optional response: null | IPayload

QuerySuccess response.

Implementation of#

IQuerySuccess.response

Methods#

toJSON#

toJSON(): Object

Converts this QuerySuccess to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): QuerySuccess

Decodes a QuerySuccess 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#

QuerySuccess

QuerySuccess


decodeDelimited#

Static decodeDelimited(reader): QuerySuccess

Decodes a QuerySuccess 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#

QuerySuccess

QuerySuccess


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): QuerySuccess

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

QuerySuccess

QuerySuccess


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageQuerySuccessQuerySuccess
options?IConversionOptions-

Returns#

Object

Plain object