Skip to main content

Class: NotifyHasPatch

coresdk.workflow_activation.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

Implements

Constructors

constructor

new NotifyHasPatch(properties?): NotifyHasPatch

Constructs a new NotifyHasPatch.

Parameters

NameTypeDescription
properties?INotifyHasPatchProperties to set

Returns

NotifyHasPatch

Properties

patchId

patchId: string

NotifyHasPatch patchId.

Implementation of

INotifyHasPatch.patchId

Methods

toJSON

toJSON(): Object

Converts this NotifyHasPatch to JSON.

Returns

Object

JSON object


create

create(properties?): NotifyHasPatch

Creates a new NotifyHasPatch instance using the specified properties.

Parameters

NameTypeDescription
properties?INotifyHasPatchProperties to set

Returns

NotifyHasPatch

NotifyHasPatch instance


decode

decode(reader, length?): NotifyHasPatch

Decodes a NotifyHasPatch message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

NotifyHasPatch

NotifyHasPatch

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): NotifyHasPatch

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

NotifyHasPatch

NotifyHasPatch

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageINotifyHasPatchNotifyHasPatch message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageINotifyHasPatchNotifyHasPatch message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): NotifyHasPatch

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

NotifyHasPatch

NotifyHasPatch


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NotifyHasPatch

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageNotifyHasPatchNotifyHasPatch
options?IConversionOptionsConversion options

Returns

Object

Plain object