Class GroupMetadataModel

14423

614423 >= 2.2222.8

Hierarchy (View Summary)

ModelProxy<Props, Session, Derived>
Model
- GroupMetadataModel

Index

Constructors

Properties

allowNonAdminSubGroupCreation? announce? attributes cachedDeviceCount? cachedDeviceSizeBucket? collection? creation? defaultSubgroup? desc? descId? descOwner? descTime? deviceQueryPromise? deviceStale? displayedDesc? ephemeralDuration? groupInviteCodePromise? groupInviteLink? groupType? growthLockExpiration? growthLockType? id idClass incognito? inviteCode? isIncognitoCag? isLidAddressingMode isParentGroup isParentGroupClosed isState isUnnamed? joinedSubgroups? lastActivityTimestamp? lastReportToAdminTimestamp? lastSeenActivityTimestamp? memberAddMode? membershipApprovalMode? mirrorMask noFrequentlyForwarded? numSubgroups? owner? parent? parentGroup? participantQueryPromise? participants pastParticipants proxyName reportToAdminMode? restrict? revokeGroupInvitePromise? revokeGroupsV4AddInvitePromise? size? stale? subject? subjectTime? support? suspended? terminated? trusted? uniqueShortNameMap? unjoinedSubgroups? unjoinedSubgroupsQueryPromise? allowedIds? idClass? Proxy

Constructors

constructor

new GroupMetadataModel(
properties?: ModelPropertiesContructor<GroupMetadataModel>,
options?: ModelOptions,
): GroupMetadataModel
Parameters
- Optionalproperties: ModelPropertiesContructor<GroupMetadataModel>
- Optionaloptions: ModelOptions
Returns GroupMetadataModel
Inherited from Model.constructor
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:90

Properties

`Optional`allowNonAdminSubGroupCreation

allowNonAdminSubGroupCreation?: any

`Optional`announce

announce?: any

`Readonly`attributes

attributes: Props & Session

`Optional`cachedDeviceCount

cachedDeviceCount?: any

`Optional`cachedDeviceSizeBucket

cachedDeviceSizeBucket?: any

`Optional`collection

collection?: undefined

`Optional`creation

creation?: any

`Optional`defaultSubgroup

defaultSubgroup?: any

`Optional`desc

desc?: string

`Optional`descId

descId?: string

`Optional`descOwner

descOwner?: any

`Optional`descTime

descTime?: any

`Optional`deviceQueryPromise

deviceQueryPromise?: any

`Optional`deviceStale

deviceStale?: any

`Optional`displayedDesc

displayedDesc?: any

`Optional`ephemeralDuration

ephemeralDuration?: any

`Optional`groupInviteCodePromise

groupInviteCodePromise?: any

`Optional` `Readonly`groupInviteLink

groupInviteLink?: any

`Optional` `Readonly`groupType

groupType?: string

`Optional`growthLockExpiration

growthLockExpiration?: any

`Optional`growthLockType

growthLockType?: any

id

id: WAJS.whatsapp.Wid

idClass

idClass: typeof WAJS.whatsapp.Wid

`Optional`incognito

incognito?: any

`Optional`inviteCode

inviteCode?: any

`Optional` `Readonly`isIncognitoCag

isIncognitoCag?: boolean

isLidAddressingMode

isLidAddressingMode: boolean

isParentGroup

isParentGroup: boolean

isParentGroupClosed

isParentGroupClosed: boolean

`Readonly`isState

isState: true

`Optional` `Readonly`isUnnamed

isUnnamed?: boolean

`Optional`joinedSubgroups

joinedSubgroups?: any

`Optional`lastActivityTimestamp

lastActivityTimestamp?: any

`Optional`lastReportToAdminTimestamp

lastReportToAdminTimestamp?: any

`Optional`lastSeenActivityTimestamp

lastSeenActivityTimestamp?: any

`Optional`memberAddMode

memberAddMode?: string

`Optional`membershipApprovalMode

membershipApprovalMode?: any

`Readonly`mirrorMask

mirrorMask: {
    "change:allowNonAdminSubGroupCreation"?: number;
    "change:announce"?: number;
    "change:cachedDeviceCount"?: number;
    "change:cachedDeviceSizeBucket"?: number;
    "change:creation"?: number;
    "change:defaultSubgroup"?: number;
    "change:desc"?: number;
    "change:descId"?: number;
    "change:descOwner"?: number;
    "change:descTime"?: number;
    "change:deviceQueryPromise"?: number;
    "change:deviceStale"?: number;
    "change:displayedDesc"?: number;
    "change:ephemeralDuration"?: number;
    "change:groupInviteCodePromise"?: number;
    "change:groupInviteLink"?: number;
    "change:groupType"?: number;
    "change:growthLockExpiration"?: number;
    "change:growthLockType"?: number;
    "change:id": number;
    "change:incognito"?: number;
    "change:inviteCode"?: number;
    "change:isIncognitoCag"?: number;
    "change:isLidAddressingMode": number;
    "change:isParentGroup": number;
    "change:isParentGroupClosed": number;
    "change:isUnnamed"?: number;
    "change:joinedSubgroups"?: number;
    "change:lastActivityTimestamp"?: number;
    "change:lastReportToAdminTimestamp"?: number;
    "change:lastSeenActivityTimestamp"?: number;
    "change:memberAddMode"?: number;
    "change:membershipApprovalMode"?: number;
    "change:noFrequentlyForwarded"?: number;
    "change:numSubgroups"?: number;
    "change:owner"?: number;
    "change:parentGroup"?: number;
    "change:participantQueryPromise"?: number;
    "change:reportToAdminMode"?: number;
    "change:restrict"?: number;
    "change:revokeGroupInvitePromise"?: number;
    "change:revokeGroupsV4AddInvitePromise"?: number;
    "change:size"?: number;
    "change:stale"?: number;
    "change:subject"?: number;
    "change:subjectTime"?: number;
    "change:support"?: number;
    "change:suspended"?: number;
    "change:terminated"?: number;
    "change:trusted"?: number;
    "change:uniqueShortNameMap"?: number;
    "change:unjoinedSubgroups"?: number;
    "change:unjoinedSubgroupsQueryPromise"?: number;
}

`Optional`noFrequentlyForwarded

noFrequentlyForwarded?: any

`Optional`numSubgroups

numSubgroups?: any

`Optional`owner

owner?: any

`Optional`parent

parent?: any

`Optional`parentGroup

parentGroup?: any

`Optional`participantQueryPromise

participantQueryPromise?: any

participants

participants: ParticipantCollection

pastParticipants

pastParticipants: ParticipantCollection

proxyName

proxyName: string

`Optional`reportToAdminMode

reportToAdminMode?: any

`Optional`restrict

restrict?: any

`Optional`revokeGroupInvitePromise

revokeGroupInvitePromise?: any

`Optional`revokeGroupsV4AddInvitePromise

revokeGroupsV4AddInvitePromise?: any

`Optional`size

size?: any

`Optional`stale

stale?: any

`Optional`subject

subject?: string

`Optional`subjectTime

subjectTime?: any

`Optional`support

support?: any

`Optional`suspended

suspended?: any

`Optional`terminated

terminated?: any

`Optional`trusted

trusted?: any

`Optional`uniqueShortNameMap

uniqueShortNameMap?: any

`Optional`unjoinedSubgroups

unjoinedSubgroups?: any

`Optional`unjoinedSubgroupsQueryPromise

unjoinedSubgroupsQueryPromise?: any

`Static` `Optional`allowedIds

allowedIds?: any[]

`Static` `Optional`idClass

idClass?: any

`Static`Proxy

Proxy: string

Methods

addChild

addChild(id: Stringable, context: { [key: string]: any }): void
Parameters
- id: Stringable
- context: { [key: string]: any }
Returns void
Inherited from Model.addChild
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:51

bind

bind(eventName: Event, listener: Listener, context?: any): this
Alias of on
Parameters
- eventName: Event
- listener: Listener
- Optionalcontext: any
Returns this
Alias
on
Inherited from Model.bind
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:85

canSetDescription

canSetDescription(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:93

canSetEphemeralSetting

canSetEphemeralSetting(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:95

canSetGroupProperty

canSetGroupProperty(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:94

canSetSubject

canSetSubject(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:92

clear

clear(): void
Returns void
Inherited from Model.clear
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:58

decObservers

decObservers(): void
Returns void
Inherited from Model.decObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:49

delete

delete(): void
Returns void
Inherited from Model.delete
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:59

emit

emit(eventName: Event, ...args: any[]): this
Alias of trigger
Parameters
- eventName: Event
- ...args: any[]
Returns this
Alias
trigger
Inherited from Model.emit
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:105

get

get<T extends keyof GroupMetadataModel>(attr: T): GroupMetadataModel[T]
Type Parameters
- T extends keyof GroupMetadataModel
Parameters
- attr: T
Returns GroupMetadataModel[T]
Inherited from Model.get
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:54

getCollection

getCollection(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:101

getDefault

getDefault<T extends keyof GroupMetadataModel>(attr: T): any
Type Parameters
- T extends keyof GroupMetadataModel
Parameters
- attr: T
Returns any
Inherited from Model.getDefault
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:61

hasObservers

hasObservers(): boolean
Returns boolean
Inherited from Model.hasObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:50

hasUnfiredChanges

hasUnfiredChanges(): boolean
Returns boolean
Inherited from Model.hasUnfiredChanges
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:56

hasUniqueShortNameMention

hasUniqueShortNameMention(e?: any): boolean
Parameters
- Optionale: any
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:91

incObservers

incObservers(e?: boolean): void
Parameters
- Optionale: boolean
Returns void
Inherited from Model.incObservers
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:48

initialize

initialize(): void
Returns void
Inherited from Model.initialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:47

isListening

isListening(eventName: Event): boolean
Parameters
- eventName: Event
Returns boolean
Inherited from Model.isListening
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:80

isTrusted

isTrusted(): boolean
Returns boolean
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:98

listenTo

listenTo(context: any, eventName: Event, listener?: Listener): this
Parameters
- context: any
  The value of this provided for the call to listener
- eventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
Returns this
Inherited from Model.listenTo
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:67

listenToAndRun

listenToAndRun(context: any, eventName: Event, listener?: Listener): this
Parameters
- context: any
  The value of this provided for the call to listener
- eventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
Returns this
Inherited from Model.listenToAndRun
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:79

listenToOnce

listenToOnce(context: any, eventName: Event, listener?: Listener): this
Parameters
- context: any
  The value of this provided for the call to listener
- eventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
Returns this
Inherited from Model.listenToOnce
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:73

off

off(eventName?: Event, listener?: Listener, context?: any): this
Removes the specified listener from the listener array for the event named eventName.
Parameters
- OptionaleventName: Event
  The name of the event.
- Optionallistener: Listener
  The callback function.
- Optionalcontext: any
  The value of this provided for the call to listener
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.off
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:55

on

on(eventName: Event, listener: Listener, context?: any): this
Adds the listener function to the end of the listeners array for the event named eventName.
Parameters
- eventName: Event
  The name of the event.
- listener: Listener
  The callback function.
- Optionalcontext: any
  The value of this provided for the call to listener
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.on
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:37

once

once(eventName: Event, listener: Listener, context?: any): this
Adds a one-time listener function for the event named eventName.
Parameters
- eventName: Event
  The name of the event.
- listener: Listener
  The callback function.
- Optionalcontext: any
  The value of this provided for the call to listener
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.once
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:46

onParticipantShortNameUpdated

onParticipantShortNameUpdated(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:96

queryGroupV4PendingInvite

queryGroupV4PendingInvite(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:100

removeAllListeners

removeAllListeners(): this
Removes all listeners.

Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.removeAllListeners
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:100

removeListener

removeListener(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from Model.removeListener
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:95

reset

reset(): void
Returns void
Inherited from Model.reset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:60

revokeGroupV4AddInvite

revokeGroupV4AddInvite(e?: any): any
Parameters
- Optionale: any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:99

serialize

serialize(): Props
Returns Props
Inherited from ModelProxy.serialize
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:26

set

set(...args: any): any
Parameters
- ...args: any
Returns any
Inherited from Model.set
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:55

stopListening

stopListening(context?: any, eventName?: Event, listener?: Listener): this
Parameters
- Optionalcontext: any
- OptionaleventName: Event
- Optionallistener: Listener
Returns this
Inherited from Model.stopListening
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:61

toJSON

toJSON(): Props
Returns Props
Inherited from ModelProxy.toJSON
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:25

trigger

trigger(eventName: Event, ...args: any[]): this
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Parameters
- eventName: Event
- ...args: any[]
Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from Model.trigger
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:60

triggerParticipantsChange

triggerParticipantsChange(): any
Returns any
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/GroupMetadataModel.d.ts:97

unbind

unbind(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from Model.unbind
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/misc/EventEmitter.d.ts:90

unset

unset(ids: Stringable | Stringable[], t?: any): void
Parameters
- ids: Stringable | Stringable[]
- Optionalt: any
Returns void
Inherited from Model.unset
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:57

`Static`isIdType

isIdType(e: any): boolean
Parameters
- e: any
Returns boolean
Inherited from Model.isIdType
- Defined in node_modules/@wppconnect/wa-js/dist/whatsapp/models/Model.d.ts:62

Class GroupMetadataModel

Whatsapp

Whatsapp

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GroupMetadataModel

Properties

OptionalallowNonAdminSubGroupCreation

Optionalannounce

Readonlyattributes

OptionalcachedDeviceCount

OptionalcachedDeviceSizeBucket

Optionalcollection

Optionalcreation

OptionaldefaultSubgroup

Optionaldesc

OptionaldescId

OptionaldescOwner

OptionaldescTime

OptionaldeviceQueryPromise

OptionaldeviceStale

OptionaldisplayedDesc

OptionalephemeralDuration

OptionalgroupInviteCodePromise

Optional ReadonlygroupInviteLink

Optional ReadonlygroupType

OptionalgrowthLockExpiration

OptionalgrowthLockType

id

idClass

Optionalincognito

OptionalinviteCode

Optional ReadonlyisIncognitoCag

isLidAddressingMode

isParentGroup

isParentGroupClosed

ReadonlyisState

Optional ReadonlyisUnnamed

OptionaljoinedSubgroups

OptionallastActivityTimestamp

OptionallastReportToAdminTimestamp

OptionallastSeenActivityTimestamp

OptionalmemberAddMode

OptionalmembershipApprovalMode

ReadonlymirrorMask

OptionalnoFrequentlyForwarded

OptionalnumSubgroups

Optionalowner

Optionalparent

OptionalparentGroup

OptionalparticipantQueryPromise

participants

pastParticipants

proxyName

OptionalreportToAdminMode

Optionalrestrict

OptionalrevokeGroupInvitePromise

OptionalrevokeGroupsV4AddInvitePromise

Optionalsize

Optionalstale

Optionalsubject

OptionalsubjectTime

Optionalsupport

Optionalsuspended

Optionalterminated

Optionaltrusted

OptionaluniqueShortNameMap

OptionalunjoinedSubgroups

OptionalunjoinedSubgroupsQueryPromise

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

Methods

addChild

`Optional`allowNonAdminSubGroupCreation

`Optional`announce

`Readonly`attributes

`Optional`cachedDeviceCount

`Optional`cachedDeviceSizeBucket

`Optional`collection

`Optional`creation

`Optional`defaultSubgroup

`Optional`desc

`Optional`descId

`Optional`descOwner

`Optional`descTime

`Optional`deviceQueryPromise

`Optional`deviceStale

`Optional`displayedDesc

`Optional`ephemeralDuration

`Optional`groupInviteCodePromise

`Optional` `Readonly`groupInviteLink

`Optional` `Readonly`groupType

`Optional`growthLockExpiration

`Optional`growthLockType

`Optional`incognito

`Optional`inviteCode

`Optional` `Readonly`isIncognitoCag

`Readonly`isState

`Optional` `Readonly`isUnnamed

`Optional`joinedSubgroups

`Optional`lastActivityTimestamp

`Optional`lastReportToAdminTimestamp

`Optional`lastSeenActivityTimestamp

`Optional`memberAddMode

`Optional`membershipApprovalMode

`Readonly`mirrorMask

`Optional`noFrequentlyForwarded

`Optional`numSubgroups

`Optional`owner

`Optional`parent

`Optional`parentGroup

`Optional`participantQueryPromise

`Optional`reportToAdminMode

`Optional`restrict

`Optional`revokeGroupInvitePromise

`Optional`revokeGroupsV4AddInvitePromise

`Optional`size

`Optional`stale

`Optional`subject

`Optional`subjectTime

`Optional`support

`Optional`suspended

`Optional`terminated

`Optional`trusted

`Optional`uniqueShortNameMap

`Optional`unjoinedSubgroups

`Optional`unjoinedSubgroupsQueryPromise

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy