Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProtocolMessage

Represents a ProtocolMessage.

Hierarchy

  • ProtocolMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional appStateFatalExceptionNotification

appStateFatalExceptionNotification: IAppStateFatalExceptionNotification

ProtocolMessage appStateFatalExceptionNotification.

Optional appStateSyncKeyRequest

appStateSyncKeyRequest: IAppStateSyncKeyRequest

ProtocolMessage appStateSyncKeyRequest.

Optional appStateSyncKeyShare

appStateSyncKeyShare: IAppStateSyncKeyShare

ProtocolMessage appStateSyncKeyShare.

Optional disappearingMode

disappearingMode: IDisappearingMode

ProtocolMessage disappearingMode.

ephemeralExpiration

ephemeralExpiration: number

ProtocolMessage ephemeralExpiration.

ephemeralSettingTimestamp

ephemeralSettingTimestamp: number | Long

ProtocolMessage ephemeralSettingTimestamp.

Optional historySyncNotification

historySyncNotification: IHistorySyncNotification

ProtocolMessage historySyncNotification.

Optional initialSecurityNotificationSettingSync

initialSecurityNotificationSettingSync: IInitialSecurityNotificationSettingSync

ProtocolMessage initialSecurityNotificationSettingSync.

Optional key

key: IMessageKey

ProtocolMessage key.

type

type: ProtocolMessageType

ProtocolMessage type.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • Decodes a ProtocolMessage 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: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns ProtocolMessage

    ProtocolMessage

Static decodeDelimited

  • Decodes a ProtocolMessage 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: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ProtocolMessage

    ProtocolMessage

Static encode

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

    Parameters

    • message: IProtocolMessage

      ProtocolMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IProtocolMessage

      ProtocolMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns ProtocolMessage

    ProtocolMessage

Static toObject

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

    Parameters

    • message: ProtocolMessage

      ProtocolMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a ProtocolMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc