Skip to main content

Class: GroupParticipant

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

Represents a GroupParticipant.

Implements​

Constructors​

new GroupParticipant()​

new GroupParticipant(properties?): GroupParticipant

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

Constructs a new GroupParticipant.

Parameters​

properties?​

IGroupParticipant

Properties to set

Returns​

GroupParticipant

Properties​

rank?​

optional rank: null | Rank

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

GroupParticipant rank.

Implementation of​

IGroupParticipant.rank

userJid​

userJid: string

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

GroupParticipant userJid.

Implementation of​

IGroupParticipant.userJid

Methods​

toJSON()​

toJSON(): object

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

Converts this GroupParticipant to JSON.

Returns​

object

JSON object

create()​

static create(properties?): GroupParticipant

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

Creates a new GroupParticipant instance using the specified properties.

Parameters​

properties?​

IGroupParticipant

Properties to set

Returns​

GroupParticipant

GroupParticipant instance

decode()​

static decode(reader, length?): GroupParticipant

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

Decodes a GroupParticipant 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​

GroupParticipant

GroupParticipant

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GroupParticipant

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

GroupParticipant

GroupParticipant

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

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

Parameters​

message​

IGroupParticipant

GroupParticipant 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:13833

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

Parameters​

message​

IGroupParticipant

GroupParticipant message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GroupParticipant

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

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

Parameters​

object​

Plain object

Returns​

GroupParticipant

GroupParticipant

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for GroupParticipant

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

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

Parameters​

message​

GroupParticipant

GroupParticipant

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a GroupParticipant message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not