Class CatalogSnapshot

Represents a CatalogSnapshot.

Hierarchy

CatalogSnapshot

Implements

ICatalogSnapshot

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CatalogSnapshot(properties?: ICatalogSnapshot): CatalogSnapshot

- Defined in WAProto/index.d.ts:13585
Constructs a new CatalogSnapshot.

Parameters
- Optional properties: ICatalogSnapshot
Returns CatalogSnapshot

Properties

Optional catalogImage

catalogImage: IImageMessage

CatalogSnapshot catalogImage.

description

description: string

CatalogSnapshot description.

title

title: string

CatalogSnapshot title.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:13670
Converts this CatalogSnapshot to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: ICatalogSnapshot): CatalogSnapshot

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

Parameters
- Optional properties: ICatalogSnapshot
Returns CatalogSnapshot

CatalogSnapshot instance

Static decode

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

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

CatalogSnapshot

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): CatalogSnapshot

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

CatalogSnapshot

Static encode

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

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

Parameters
- message: ICatalogSnapshot
  
  CatalogSnapshot message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

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

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

Parameters
- message: ICatalogSnapshot
  
  CatalogSnapshot message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): CatalogSnapshot

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

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

CatalogSnapshot

Static toObject

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

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

Parameters
- message: CatalogSnapshot
  
  CatalogSnapshot
- Optional options: IConversionOptions
Returns {}

Plain object
- [k: string]: any

Static verify

verify(message: {}): string

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