Class: TypedMessage

TypedMessage(messagenon-null, typenon-null)

A Protobuf message with a TypeUrl. The type URL specifies the type of the associated message.

Constructor

new TypedMessage(messagenon-null, typenon-null)

Creates a new instance of TypedMessage from the given Protobuf message and type URL.
Parameters:
Name Type Description
message Message a Protobuf message
type Type.<T> a Protobuf type of the message
Source:

Classes

TypedMessage

Methods

toBase64()

Converts this message into a Base64-encoded byte string.
Source:
Returns:
the string representing this message

(static) bool(value) → {TypedMessage.<BoolValue>}

Creates a new `TypedMessage` with a boolean value.
Parameters:
Name Type Description
value boolean | Boolean `true` or `false` value for the `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<BoolValue>

(static) double(value) → {TypedMessage.<DoubleValue>}

Creates a new `TypedMessage` with a double value.
Parameters:
Name Type Description
value number | Number a number value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<DoubleValue>

(static) float(value) → {TypedMessage.<FloatValue>}

Creates a new `TypedMessage` with a float value.
Parameters:
Name Type Description
value number | Number a number value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<FloatValue>

(static) int32(value) → {TypedMessage.<Int32Value>}

Creates a new `TypedMessage` with a 32-bit integer value. The number gets floored if the provided value contains a floating point.
Parameters:
Name Type Description
value number | Number a number value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<Int32Value>

(static) int64(value) → {TypedMessage.<Int64Value>}

Creates a new `TypedMessage` with a 64-bit integer value. The number gets floored if the provided value contains a floating point.
Parameters:
Name Type Description
value number | Number a number value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<Int64Value>

(static) of(messagenon-null) → (non-null) {TypedMessage}

Creates a new instance of TypedMessage from the given Protobuf message.
Parameters:
Name Type Description
message Message a Protobuf message
Source:
Returns:
the created typed message
Type
TypedMessage

(static) string(valuenon-null) → {TypedMessage.<StringValue>}

Creates a new `TypedMessage` wrapping a string.
Parameters:
Name Type Description
value String a string value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<StringValue>

(static) timestamp(datenon-null) → {TypedMessage.<Timestamp>}

Creates a new `TypedMessage` with a timestamp value composed from the given JavaScript date.
Parameters:
Name Type Description
date Date a JavaScript `Date` value
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<Timestamp>

(static) uint32(value) → {TypedMessage.<UInt32Value>}

Creates a new `TypedMessage` with an unsigned 32-bit integer value. The number gets floored if the provided value contains a floating point.
Parameters:
Name Type Description
value number | Number a number value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<UInt32Value>

(static) uint64(value) → {TypedMessage.<UInt64Value>}

Creates a new `TypedMessage` with an unsigned 64-bit integer value. The number gets floored if the provided value contains a floating point.
Parameters:
Name Type Description
value number | Number a number value for `TypedMessage`
Source:
Returns:
a new `TypedMessage` instance with provided value
Type
TypedMessage.<UInt64Value>