Skip to main content

Class: Alert

version.v1.Alert

Represents an Alert.

Implements#

Constructors#

constructor#

new Alert(properties?)

Constructs a new Alert.

Parameters#

NameType
properties?IAlert

Properties#

message#

message: string

Alert message.

Implementation of#

IAlert.message


severity#

severity: Severity

Alert severity.

Implementation of#

IAlert.severity

Methods#

toJSON#

toJSON(): Object

Converts this Alert to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): Alert

Decodes an Alert 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#

Alert

Alert


decodeDelimited#

Static decodeDelimited(reader): Alert

Decodes an Alert 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#

Alert

Alert


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): Alert

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

Alert

Alert


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageAlertAlert
options?IConversionOptions-

Returns#

Object

Plain object