Class GroupMetadataModel

constructor

• new GroupMetadataModel(proterties?, options?): GroupMetadataModel

• Parameters

  • Optional proterties: ModelPropertiesContructor<GroupMetadataModel>
  • Optional options: ModelOptions

  Returns GroupMetadataModel

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

id

idClass

Optional incognito

Optional inviteCode

Optional Readonly isIncognitoCag

isLidAddressingMode

isParentGroup

isParentGroupClosed

Readonly isState

Optional Readonly isUnnamed

Optional joinedSubgroups

Optional lastActivityTimestamp

Optional lastReportToAdminTimestamp

Optional lastSeenActivityTimestamp

Optional membershipApprovalMode

Readonly mirrorMask

Optional noFrequentlyForwarded

Optional numSubgroups

Optional owner

Optional parent

Optional parentGroup

Optional participantQueryPromise

participants

proxyName

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 Proxy

Static Optional allowedIds

Static Optional idClass

addChild

• addChild(id, context): void

• Parameters

  • id: Stringable
  • context: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns void

bind

• bind(eventName, listener, context?): this

• Alias of on

  Parameters

  • eventName: Event
  • listener: Listener
  • Optional context: any

  Returns this

  Alias

  on

canSetDescription

• canSetDescription(): boolean

• Returns boolean

canSetEphemeralSetting

• canSetEphemeralSetting(): boolean

• Returns boolean

canSetGroupProperty

• canSetGroupProperty(): boolean

• Returns boolean

canSetSubject

• canSetSubject(): boolean

• Returns boolean

clear

• clear(): void

• Returns void

decObservers

• decObservers(): void

• Returns void

delete

• delete(): void

• Returns void

emit

• emit(eventName, ...args): this

• Alias of trigger

  Parameters

  • eventName: Event
  • Rest ...args: any[]

  Returns this

  Alias

  trigger

get

• get<T>(attr): GroupMetadataModel[T]

• Type Parameters

  • T extends keyof GroupMetadataModel

  Parameters

  • attr: T

  Returns GroupMetadataModel[T]

getCollection

• getCollection(): any

• Returns any

getDefault

• getDefault<T>(attr): any

• Type Parameters

  • T extends keyof GroupMetadataModel

  Parameters

  • attr: T

  Returns any

hasObservers

• hasObservers(): boolean

• Returns boolean

hasUnfiredChanges

• hasUnfiredChanges(): boolean

• Returns boolean

hasUniqueShortNameMention

• hasUniqueShortNameMention(e?): boolean

• Parameters

  • Optional e: any

  Returns boolean

incObservers

• incObservers(e?): void

• Parameters

  • Optional e: boolean

  Returns void

initialize

• initialize(): void

• Returns void

isListening

• isListening(eventName): boolean

• Parameters

  • eventName: Event

  Returns boolean

isTrusted

• isTrusted(): boolean

• Returns boolean

listenTo

• listenTo(context, eventName, listener?): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

listenToAndRun

• listenToAndRun(context, eventName, listener?): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

listenToOnce

• listenToOnce(context, eventName, listener?): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

off

• off(eventName?, listener?, context?): this

• Removes the specified listener from the listener array for the event named eventName.

  Parameters

  • Optional eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.
  • Optional context: 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.

on

• on(eventName, listener, context?): 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.
  • Optional context: 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.

onParticipantShortNameUpdated

• onParticipantShortNameUpdated(): any

• Returns any

once

• once(eventName, listener, context?): 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.
  • Optional context: 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.

queryGroupV4PendingInvite

• queryGroupV4PendingInvite(): any

• Returns any

removeAllListeners

• removeAllListeners(): this

• Removes all listeners.

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

removeListener

• removeListener(eventName?, listener?, context?): this

• Alias of off

  Parameters

  • Optional eventName: Event
  • Optional listener: Listener
  • Optional context: any

  Returns this

  Alias

  off

reset

• reset(): void

• Returns void

revokeGroupV4AddInvite

• revokeGroupV4AddInvite(e?): any

• Parameters

  • Optional e: any

  Returns any

serialize

• serialize(): Props

• Returns Props

set

• set(...args): any

• Parameters

  • Rest ...args: any

  Returns any

stopListening

• stopListening(context?, eventName?, listener?): this

• Parameters

  • Optional context: any
  • Optional eventName: Event
  • Optional listener: Listener

  Returns this

toJSON

• toJSON(): Props

• Returns Props

trigger

• trigger(eventName, ...args): 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
  • Rest ...args: any[]

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

triggerParticipantsChange

• triggerParticipantsChange(): any

• Returns any

unbind

• unbind(eventName?, listener?, context?): this

• Alias of off

  Parameters

  • Optional eventName: Event
  • Optional listener: Listener
  • Optional context: any

  Returns this

  Alias

  off

unset

• unset(ids, t?): void

• Parameters

  • ids: Stringable | Stringable[]
  • Optional t: any

  Returns void

Static isIdType

• isIdType(e): boolean

• Parameters

  • e: any

  Returns boolean