Class: Alert
Alert contains notification and severity.
Implements
Constructors
constructor
• new Alert(properties?): Alert
Constructs a new Alert.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IAlert | Properties to set |
Returns
Properties
message
• message: string
Alert message.
Implementation of
severity
• severity: Severity
Alert severity.
Implementation of
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
| Name | Type | Description |
|---|---|---|
properties? | IAlert | Properties to set |
Returns
Alert instance
decode
▸ decode(reader, length?): Alert
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
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 | IAlert | 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 | IAlert | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Alert
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your 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
| Name | Type | Description |
|---|---|---|
message | Alert | Alert |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object