Class: Reportable

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

Represents a Reportable.

Implements

• IReportable

Constructors

new Reportable()

new Reportable(properties?): Reportable

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

Constructs a new Reportable.

Parameters

properties?

IReportable

Properties to set

Returns

Reportable

Properties

maxVersion?

optional maxVersion: null | number

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

Reportable maxVersion.

Implementation of

IReportable.maxVersion

---

minVersion?

optional minVersion: null | number

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

Reportable minVersion.

Implementation of

IReportable.minVersion

---

never?

optional never: null | boolean

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

Reportable never.

Implementation of

IReportable.never

---

notReportableMinVersion?

optional notReportableMinVersion: null | number

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

Reportable notReportableMinVersion.

Implementation of

IReportable.notReportableMinVersion

Methods

toJSON()

toJSON(): object

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

Converts this Reportable to JSON.

Returns

object

JSON object

---

create()

static create(properties?): Reportable

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

Creates a new Reportable instance using the specified properties.

Parameters

properties?

IReportable

Properties to set

Returns

Reportable

Reportable instance

---

decode()

static decode(reader, length?): Reportable

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

Decodes a Reportable 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

Reportable

Reportable

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): Reportable

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

Decodes a Reportable message from the specified reader or buffer, length delimited.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

Reportable

Reportable

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:38045

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

Parameters

message

IReportable

Reportable 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:38053

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

Parameters

message

IReportable

Reportable message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): Reportable

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

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

Parameters

object

Plain object

Returns

Reportable

Reportable

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for Reportable

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:38094

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

Parameters

message

Reportable

Reportable

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a Reportable message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not