Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a ChatMessage.

Hierarchy

  • ChatMessage

Implements

Index

Constructors

constructor

  • Constructs a new ChatMessage.

    Parameters

    Returns ChatMessage

Properties

text

text: string

ChatMessage text.

username

username: string

ChatMessage username.

Methods

toJSON

  • toJSON(): object
  • Converts this ChatMessage to JSON.

    Returns object

    JSON object

    • [k: string]: any

Static create

  • Creates a new ChatMessage instance using the specified properties.

    Parameters

    Returns ChatMessage

    ChatMessage instance

Static decode

  • decode(reader: Reader | Uint8Array, length?: undefined | number): ChatMessage
  • Decodes a ChatMessage message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    • Optional length: undefined | number

    Returns ChatMessage

    ChatMessage

Static decodeDelimited

  • decodeDelimited(reader: Reader | Uint8Array): ChatMessage
  • Decodes a ChatMessage message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    Returns ChatMessage

    ChatMessage

Static encode

  • encode(message: IChatMessage, writer?: $protobuf.Writer): Writer
  • Encodes the specified ChatMessage message. Does not implicitly verify messages.

    Parameters

    • message: IChatMessage

      ChatMessage message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IChatMessage, writer?: $protobuf.Writer): Writer
  • Encodes the specified ChatMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IChatMessage

      ChatMessage message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static fromObject

  • Creates a ChatMessage message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: object

      Plain object

      • [k: string]: any

    Returns ChatMessage

    ChatMessage

Static toObject

  • toObject(message: ChatMessage, options?: $protobuf.IConversionOptions): object
  • Creates a plain object from a ChatMessage message. Also converts values to other types if specified.

    Parameters

    • message: ChatMessage

      ChatMessage

    • Optional options: $protobuf.IConversionOptions

    Returns object

    Plain object

    • [k: string]: any

Static verify

  • verify(message: object): null | string
  • Verifies a ChatMessage message.

    Parameters

    • message: object

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc