Skip to main content

Class: ModifyWorkflowProperties

Represents a ModifyWorkflowProperties.

Properties​

upsertedMemo?​

optional upsertedMemo?: $Properties | null

If set, update the workflow memo with the provided values. The values will be merged with the existing memo. If the user wants to delete values, a default/empty Payload should be used as the value for the key being deleted.

Methods​

toJSON()​

toJSON(): object

Converts this ModifyWorkflowProperties to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ModifyWorkflowProperties & $Properties

Creates a new ModifyWorkflowProperties instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ModifyWorkflowProperties & $Properties

ModifyWorkflowProperties instance

Call Signature​

static create(properties?): ModifyWorkflowProperties

Creates a new ModifyWorkflowProperties instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ModifyWorkflowProperties

ModifyWorkflowProperties instance

decode()​

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

Decodes a ModifyWorkflowProperties 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​

ModifyWorkflowProperties & $Properties

ModifyWorkflowProperties

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ModifyWorkflowProperties & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ModifyWorkflowProperties & $Properties

ModifyWorkflowProperties

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 ModifyWorkflowProperties message. Does not implicitly coresdk.workflow_commands.ModifyWorkflowProperties.verify|verify messages.

Parameters​

message​

$Properties

ModifyWorkflowProperties message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ModifyWorkflowProperties message, length delimited. Does not implicitly coresdk.workflow_commands.ModifyWorkflowProperties.verify|verify messages.

Parameters​

message​

$Properties

ModifyWorkflowProperties message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ModifyWorkflowProperties

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ModifyWorkflowProperties

ModifyWorkflowProperties

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ModifyWorkflowProperties

ModifyWorkflowProperties

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object