Skip to main content

Class: Memo

common.v1.Memo

Represents a Memo.

Implements#

Constructors#

constructor#

new Memo(properties?)

Constructs a new Memo.

Parameters#

NameType
properties?IMemo

Properties#

fields#

fields: Object

Memo fields.

Index signature#

▪ [k: string]: IPayload

Implementation of#

IMemo.fields

Methods#

toJSON#

toJSON(): Object

Converts this Memo to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): Memo

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

Memo

Memo


decodeDelimited#

Static decodeDelimited(reader): Memo

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

Memo

Memo


encode#

Static encode(message, writer?): Writer

Encodes the specified Memo message. Does not implicitly {@link temporal.api.common.v1.Memo.verify|verify} messages.

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified Memo message, length delimited. Does not implicitly {@link temporal.api.common.v1.Memo.verify|verify} messages.

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): Memo

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

Memo

Memo


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageMemoMemo
options?IConversionOptions-

Returns#

Object

Plain object