Class HandshakeMessage

Represents a HandshakeMessage.

Hierarchy

HandshakeMessage

Implements

IHandshakeMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HandshakeMessage(properties?: IHandshakeMessage): HandshakeMessage

- Defined in WAProto/index.d.ts:1626
Constructs a new HandshakeMessage.

Parameters
- Optional properties: IHandshakeMessage
Returns HandshakeMessage

Properties

Optional clientFinish

clientFinish?: IClientFinish

HandshakeMessage clientFinish.

Optional clientHello

clientHello?: IClientHello

HandshakeMessage clientHello.

Optional serverHello

serverHello?: IServerHello

HandshakeMessage serverHello.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:1705
Converts this HandshakeMessage to JSON.

Returns {}
JSON object
- [k: string]: any

Static create

create(properties?: IHandshakeMessage): HandshakeMessage

- Defined in WAProto/index.d.ts:1642
Creates a new HandshakeMessage instance using the specified properties.

Parameters
- Optional properties: IHandshakeMessage
Returns HandshakeMessage
HandshakeMessage instance

Static decode

decode(reader: Uint8Array | Reader, length?: number): HandshakeMessage

- Defined in WAProto/index.d.ts:1668
Decodes a HandshakeMessage 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 HandshakeMessage
HandshakeMessage

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): HandshakeMessage

- Defined in WAProto/index.d.ts:1677
Decodes a HandshakeMessage 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 HandshakeMessage
HandshakeMessage

Static encode

encode(message: IHandshakeMessage, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:1650
Encodes the specified HandshakeMessage message. Does not implicitly verify messages.

Parameters
- message: IHandshakeMessage
  
  HandshakeMessage message or plain object to encode
- Optional writer: Writer
Returns Writer
Writer

Static encodeDelimited

encodeDelimited(message: IHandshakeMessage, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:1658
Encodes the specified HandshakeMessage message, length delimited. Does not implicitly verify messages.

Parameters
- message: IHandshakeMessage
  
  HandshakeMessage message or plain object to encode
- Optional writer: Writer
Returns Writer
Writer

Static fromObject

fromObject(object: {}): HandshakeMessage

- Defined in WAProto/index.d.ts:1691
Creates a HandshakeMessage message from a plain object. Also converts values to their respective internal types.

Parameters
- object: {}
  
  Plain object
  - [k: string]: any
Returns HandshakeMessage
HandshakeMessage

Static toObject

toObject(message: HandshakeMessage, options?: IConversionOptions): {}

- Defined in WAProto/index.d.ts:1699
Creates a plain object from a HandshakeMessage message. Also converts values to other types if specified.

Parameters
- message: HandshakeMessage
  
  HandshakeMessage
- Optional options: IConversionOptions
Returns {}
Plain object
- [k: string]: any

Static verify

verify(message: {}): string

- Defined in WAProto/index.d.ts:1684
Verifies a HandshakeMessage 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