Class: GroupInviteMessage

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

Represents a GroupInviteMessage.

Implements

• IGroupInviteMessage

Constructors

new GroupInviteMessage()

new GroupInviteMessage(properties?): GroupInviteMessage

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

Constructs a new GroupInviteMessage.

Parameters

properties?

IGroupInviteMessage

Properties to set

Returns

GroupInviteMessage

Properties

caption?

optional caption: null | string

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

GroupInviteMessage caption.

Implementation of

IGroupInviteMessage.caption

---

contextInfo?

optional contextInfo: null | IContextInfo

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

GroupInviteMessage contextInfo.

Implementation of

IGroupInviteMessage.contextInfo

---

groupJid?

optional groupJid: null | string

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

GroupInviteMessage groupJid.

Implementation of

IGroupInviteMessage.groupJid

---

groupName?

optional groupName: null | string

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

GroupInviteMessage groupName.

Implementation of

IGroupInviteMessage.groupName

---

groupType?

optional groupType: null | GroupType

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

GroupInviteMessage groupType.

Implementation of

IGroupInviteMessage.groupType

---

inviteCode?

optional inviteCode: null | string

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

GroupInviteMessage inviteCode.

Implementation of

IGroupInviteMessage.inviteCode

---

inviteExpiration?

optional inviteExpiration: null | number | Long

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

GroupInviteMessage inviteExpiration.

Implementation of

IGroupInviteMessage.inviteExpiration

---

jpegThumbnail?

optional jpegThumbnail: null | Uint8Array<ArrayBufferLike>

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

GroupInviteMessage jpegThumbnail.

Implementation of

IGroupInviteMessage.jpegThumbnail

Methods

toJSON()

toJSON(): object

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

Converts this GroupInviteMessage to JSON.

Returns

object

JSON object

---

create()

static create(properties?): GroupInviteMessage

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

Creates a new GroupInviteMessage instance using the specified properties.

Parameters

properties?

IGroupInviteMessage

Properties to set

Returns

GroupInviteMessage

GroupInviteMessage instance

---

decode()

static decode(reader, length?): GroupInviteMessage

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

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

GroupInviteMessage

GroupInviteMessage

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): GroupInviteMessage

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

GroupInviteMessage

GroupInviteMessage

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

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

Parameters

message

IGroupInviteMessage

GroupInviteMessage 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:23593

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

Parameters

message

IGroupInviteMessage

GroupInviteMessage message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): GroupInviteMessage

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

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

Parameters

object

Plain object

Returns

GroupInviteMessage

GroupInviteMessage

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for GroupInviteMessage

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

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

Parameters

message

GroupInviteMessage

GroupInviteMessage

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a GroupInviteMessage message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not