Class CompanionProps

Represents a CompanionProps.

Hierarchy

CompanionProps

Implements

ICompanionProps

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CompanionProps(properties?: ICompanionProps): CompanionProps

- Defined in WAProto/index.d.ts:18936
Constructs a new CompanionProps.

Parameters
- Optional properties: ICompanionProps
Returns CompanionProps

Properties

os

os: string

CompanionProps os.

platformType

platformType: CompanionPropsPlatformType

CompanionProps platformType.

requireFullSync

requireFullSync: boolean

CompanionProps requireFullSync.

Optional version

version: IAppVersion

CompanionProps version.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:19024
Converts this CompanionProps to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: ICompanionProps): CompanionProps

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

Parameters
- Optional properties: ICompanionProps
Returns CompanionProps

CompanionProps instance

Static decode

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

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

CompanionProps

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): CompanionProps

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

CompanionProps

Static encode

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

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

Parameters
- message: ICompanionProps
  
  CompanionProps message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

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

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

Parameters
- message: ICompanionProps
  
  CompanionProps message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): CompanionProps

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

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

CompanionProps

Static toObject

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

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

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

Plain object
- [k: string]: any

Static verify

verify(message: {}): string

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