Class: Alert
Alert contains notification and severity.
Properties
message
• message: string
Alert message.
severity
• severity: Severity
Alert severity.
Methods
toJSON
▸ toJSON(): Object
Converts this Alert to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Alert & $Properties
Creates a new Alert instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Alert instance
▸ create(properties?): Alert
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Alert & $Properties
Decodes an Alert message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Alert
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Alert & $Properties
Decodes an Alert message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | $Properties | Alert message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | $Properties | Alert message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Alert
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Alert message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Alert | Alert |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object