Skip to main content

Class: IdentityKeyPairStructure

Defined in: WAProto/index.d.ts:15106

Represents an IdentityKeyPairStructure.

Implements

Constructors

new IdentityKeyPairStructure()

new IdentityKeyPairStructure(properties?): IdentityKeyPairStructure

Defined in: WAProto/index.d.ts:15112

Constructs a new IdentityKeyPairStructure.

Parameters

properties?

IIdentityKeyPairStructure

Properties to set

Returns

IdentityKeyPairStructure

Properties

privateKey?

optional privateKey: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:15118

IdentityKeyPairStructure privateKey.

Implementation of

IIdentityKeyPairStructure.privateKey


publicKey?

optional publicKey: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:15115

IdentityKeyPairStructure publicKey.

Implementation of

IIdentityKeyPairStructure.publicKey

Methods

toJSON()

toJSON(): object

Defined in: WAProto/index.d.ts:15188

Converts this IdentityKeyPairStructure to JSON.

Returns

object

JSON object


create()

static create(properties?): IdentityKeyPairStructure

Defined in: WAProto/index.d.ts:15125

Creates a new IdentityKeyPairStructure instance using the specified properties.

Parameters

properties?

IIdentityKeyPairStructure

Properties to set

Returns

IdentityKeyPairStructure

IdentityKeyPairStructure instance


decode()

static decode(reader, length?): IdentityKeyPairStructure

Defined in: WAProto/index.d.ts:15151

Decodes an IdentityKeyPairStructure 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

IdentityKeyPairStructure

IdentityKeyPairStructure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited()

static decodeDelimited(reader): IdentityKeyPairStructure

Defined in: WAProto/index.d.ts:15160

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

IdentityKeyPairStructure

IdentityKeyPairStructure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode()

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:15133

Encodes the specified IdentityKeyPairStructure message. Does not implicitly verify messages.

Parameters

message

IIdentityKeyPairStructure

IdentityKeyPairStructure message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


encodeDelimited()

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:15141

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

Parameters

message

IIdentityKeyPairStructure

IdentityKeyPairStructure message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


fromObject()

static fromObject(object): IdentityKeyPairStructure

Defined in: WAProto/index.d.ts:15174

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

Parameters

object

Plain object

Returns

IdentityKeyPairStructure

IdentityKeyPairStructure


getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:15195

Gets the default type url for IdentityKeyPairStructure

Parameters

typeUrlPrefix?

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject()

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:15182

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

Parameters

message

IdentityKeyPairStructure

IdentityKeyPairStructure

options?

IConversionOptions

Conversion options

Returns

object

Plain object


verify()

static verify(message): null | string

Defined in: WAProto/index.d.ts:15167

Verifies an IdentityKeyPairStructure message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not