Skip to main content

Class: NotifyHasPatch

Inform lang what the result of a call to patched or similar API should be -- this is always sent pre-emptively, so any time it is sent the change is present

Properties​

patchId​

patchId: string

NotifyHasPatch patchId.

Methods​

toJSON()​

toJSON(): object

Converts this NotifyHasPatch to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NotifyHasPatch & $Properties

Creates a new NotifyHasPatch instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NotifyHasPatch & $Properties

NotifyHasPatch instance

Call Signature​

static create(properties?): NotifyHasPatch

Creates a new NotifyHasPatch instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NotifyHasPatch

NotifyHasPatch instance

decode()​

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

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

NotifyHasPatch & $Properties

NotifyHasPatch

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NotifyHasPatch & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NotifyHasPatch & $Properties

NotifyHasPatch

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

Parameters​

message​

$Properties

NotifyHasPatch message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NotifyHasPatch message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NotifyHasPatch

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

NotifyHasPatch

NotifyHasPatch

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NotifyHasPatch

NotifyHasPatch

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object