Class: ChatMessage
protocol.ChatMessage
Represents a ChatMessage.
Implements
Constructors
constructor
• new ChatMessage(properties?): ChatMessage
Constructs a new ChatMessage.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IChatMessage | Properties to set |
Returns
Properties
body
• body: string
ChatMessage body.
Implementation of
sender
• sender: string
ChatMessage sender.
Implementation of
type
• type: string
ChatMessage type.
Implementation of
Methods
create
▸ create(properties?): ChatMessage
Creates a new ChatMessage instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IChatMessage | Properties to set |
Returns
ChatMessage instance
decode
▸ decode(reader, length?): ChatMessage
Decodes a ChatMessage message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ChatMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ChatMessage
Decodes a ChatMessage message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
Returns
ChatMessage
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 ChatMessage message. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IChatMessage | ChatMessage message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ChatMessage message, length delimited. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IChatMessage | ChatMessage message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ChatMessage
Creates a ChatMessage message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ChatMessage
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ChatMessage
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toJSON
▸ toJSON(): Object
Converts this ChatMessage to JSON.
Returns
Object
JSON object
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ChatMessage message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ChatMessage | ChatMessage |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object
verify
▸ verify(message): string
Verifies a ChatMessage message.
Parameters
| Name | Type | Description |
|---|---|---|
message | Object | Plain object to verify |
Returns
string
null if valid, otherwise the reason why it is not