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