Class EventMessage

Represents an EventMessage.

Hierarchy

  • EventMessage

Implements

Constructors

Properties

contextInfo?: null | IContextInfo

EventMessage contextInfo.

description: string

EventMessage description.

isCanceled: boolean

EventMessage isCanceled.

joinLink: string

EventMessage joinLink.

location?: null | ILocationMessage

EventMessage location.

name: string

EventMessage name.

startTime: number | Long

EventMessage startTime.

Methods

  • Converts this EventMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes an EventMessage message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns EventMessage

    EventMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes an EventMessage message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns EventMessage

    EventMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified EventMessage message. Does not implicitly verify messages.

    Parameters

    • message: IEventMessage

      EventMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified EventMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IEventMessage

      EventMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns EventMessage

    EventMessage

  • Creates a plain object from an EventMessage message. Also converts values to other types if specified.

    Parameters

    • message: EventMessage

      EventMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies an EventMessage message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc