Skip to main content

Class: Alert

version.v1.Alert

Alert contains notification and severity.

Implements

Constructors

constructor

new Alert(properties?): Alert

Constructs a new Alert.

Parameters

NameTypeDescription
properties?IAlertProperties to set

Returns

Alert

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


create

create(properties?): Alert

Creates a new Alert instance using the specified properties.

Parameters

NameTypeDescription
properties?IAlertProperties to set

Returns

Alert

Alert instance


decode

decode(reader, length?): Alert

Decodes an Alert message from the specified reader or buffer.

Parameters

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

Returns

Alert

Alert

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Alert

Decodes an Alert message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Alert

Alert

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 Alert message. Does not implicitly temporal.api.version.v1.Alert.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Alert

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 an Alert message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageAlertAlert
options?IConversionOptionsConversion options

Returns

Object

Plain object