Class GroupInviteMessage

Represents a GroupInviteMessage.

Hierarchy

GroupInviteMessage

Implements

IGroupInviteMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GroupInviteMessage(properties?: IGroupInviteMessage): GroupInviteMessage

- Defined in WAProto/index.d.ts:16049
Constructs a new GroupInviteMessage.

Parameters
- Optional properties: IGroupInviteMessage
Returns GroupInviteMessage

Properties

caption

caption: string

GroupInviteMessage caption.

Optional contextInfo

contextInfo?: IContextInfo

GroupInviteMessage contextInfo.

groupJid

groupJid: string

GroupInviteMessage groupJid.

groupName

groupName: string

GroupInviteMessage groupName.

groupType

groupType: GroupInviteMessageGroupType

GroupInviteMessage groupType.

inviteCode

inviteCode: string

GroupInviteMessage inviteCode.

inviteExpiration

inviteExpiration: number | Long

GroupInviteMessage inviteExpiration.

jpegThumbnail

jpegThumbnail: Uint8Array

GroupInviteMessage jpegThumbnail.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:16143
Converts this GroupInviteMessage to JSON.

Returns {}
JSON object
- [k: string]: any

Static create

create(properties?: IGroupInviteMessage): GroupInviteMessage

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

Parameters
- Optional properties: IGroupInviteMessage
Returns GroupInviteMessage
GroupInviteMessage instance

Static decode

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

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

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): GroupInviteMessage

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

Static encode

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

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

Parameters
- message: IGroupInviteMessage
  
  GroupInviteMessage message or plain object to encode
- Optional writer: Writer
Returns Writer
Writer

Static encodeDelimited

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

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

Parameters
- message: IGroupInviteMessage
  
  GroupInviteMessage message or plain object to encode
- Optional writer: Writer
Returns Writer
Writer

Static fromObject

fromObject(object: {}): GroupInviteMessage

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

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

Static toObject

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

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

Parameters
- message: GroupInviteMessage
  
  GroupInviteMessage
- Optional options: IConversionOptions
Returns {}
Plain object
- [k: string]: any

Static verify

verify(message: {}): string

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