Class: HandshakeMessage
Defined in: WAProto/index.d.ts:13914
Represents a HandshakeMessage.
Implements
Constructors
new HandshakeMessage()
new HandshakeMessage(
properties?):HandshakeMessage
Defined in: WAProto/index.d.ts:13920
Constructs a new HandshakeMessage.
Parameters
properties?
Properties to set
Returns
Properties
clientFinish?
optionalclientFinish:null|IClientFinish
Defined in: WAProto/index.d.ts:13929
HandshakeMessage clientFinish.
Implementation of
IHandshakeMessage.clientFinish
clientHello?
optionalclientHello:null|IClientHello
Defined in: WAProto/index.d.ts:13923
HandshakeMessage clientHello.
Implementation of
serverHello?
optionalserverHello:null|IServerHello
Defined in: WAProto/index.d.ts:13926
HandshakeMessage serverHello.
Implementation of
Methods
toJSON()
toJSON():
object
Defined in: WAProto/index.d.ts:13999
Converts this HandshakeMessage to JSON.
Returns
object
JSON object
create()
staticcreate(properties?):HandshakeMessage
Defined in: WAProto/index.d.ts:13936
Creates a new HandshakeMessage instance using the specified properties.
Parameters
properties?
Properties to set
Returns
HandshakeMessage instance
decode()
staticdecode(reader,length?):HandshakeMessage
Defined in: WAProto/index.d.ts:13962
Decodes a HandshakeMessage message from the specified reader or buffer.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
length?
number
Message length if known beforehand
Returns
HandshakeMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):HandshakeMessage
Defined in: WAProto/index.d.ts:13971
Decodes a HandshakeMessage message from the specified reader or buffer, length delimited.
Parameters
reader
Reader or buffer to decode from
Uint8Array<ArrayBufferLike> | Reader
Returns
HandshakeMessage
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Defined in: WAProto/index.d.ts:13944
Encodes the specified HandshakeMessage message. Does not implicitly verify messages.
Parameters
message
HandshakeMessage message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Defined in: WAProto/index.d.ts:13952
Encodes the specified HandshakeMessage message, length delimited. Does not implicitly verify messages.
Parameters
message
HandshakeMessage message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):HandshakeMessage
Defined in: WAProto/index.d.ts:13985
Creates a HandshakeMessage message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
HandshakeMessage
getTypeUrl()
staticgetTypeUrl(typeUrlPrefix?):string
Defined in: WAProto/index.d.ts:14006
Gets the default type url for HandshakeMessage
Parameters
typeUrlPrefix?
string
your custom typeUrlPrefix(default "type.googleapis.com")
Returns
string
The default type url
toObject()
statictoObject(message,options?):object
Defined in: WAProto/index.d.ts:13993
Creates a plain object from a HandshakeMessage message. Also converts values to other types if specified.
Parameters
message
HandshakeMessage
options?
IConversionOptions
Conversion options
Returns
object
Plain object
verify()
staticverify(message):null|string
Defined in: WAProto/index.d.ts:13978
Verifies a HandshakeMessage message.
Parameters
message
Plain object to verify
Returns
null | string
null if valid, otherwise the reason why it is not