@wppconnect-team/wppconnect - v1.36.4
    Preparing search index...

    Interface GroupMetadata

    interface GroupMetadata {
        allowNonAdminSubGroupCreation: boolean;
        announce: boolean;
        creation: number;
        defaultSubgroup: boolean;
        desc: string;
        descId: string;
        descOwner: Wid;
        descTime: number;
        displayCadminPromotion: boolean;
        ephemeralDuration: number;
        generalChatAutoAddDisabled: boolean;
        generalSubgroup: boolean;
        hasCapi: boolean;
        id: Wid;
        incognito: boolean;
        isLidAddressingMode: boolean;
        isParentGroup: boolean;
        isParentGroupClosed: boolean;
        lastActivityTimestamp: number;
        lastSeenActivityTimestamp: number;
        memberAddMode: string;
        membershipApprovalMode: boolean;
        membershipApprovalRequests: any[];
        noFrequentlyForwarded: boolean;
        owner: Wid;
        parentGroup: string;
        participants: { id: Wid; isAdmin: boolean; isSuperAdmin: boolean }[];
        pastParticipants: {
            id: Wid;
            leaveReason: "Left" | "Removed";
            leaveTs: number;
        }[];
        pendingParticipants: any[];
        reportToAdminMode: boolean;
        restrict: boolean;
        size: number;
        subgroupSuggestions: any[];
        subject: string;
        subjectTime: number;
        support: boolean;
        suspended: boolean;
        terminated: boolean;
        uniqueShortNameMap: Object;
    }
    Index

    Properties

    allowNonAdminSubGroupCreation announce creation defaultSubgroup desc descId descOwner descTime displayCadminPromotion ephemeralDuration generalChatAutoAddDisabled generalSubgroup hasCapi id incognito isLidAddressingMode isParentGroup isParentGroupClosed lastActivityTimestamp lastSeenActivityTimestamp memberAddMode membershipApprovalMode membershipApprovalRequests noFrequentlyForwarded owner parentGroup participants pastParticipants pendingParticipants reportToAdminMode restrict size subgroupSuggestions subject subjectTime support suspended terminated uniqueShortNameMap

    Properties

    allowNonAdminSubGroupCreation: boolean
    announce: boolean

    whether it is an announcement channel of a community

    creation: number

    timestamp of when the group was created

    defaultSubgroup: boolean
    desc: string

    description of the group

    descId: string
    descOwner: Wid
    descTime: number
    displayCadminPromotion: boolean
    ephemeralDuration: number
    generalChatAutoAddDisabled: boolean
    generalSubgroup: boolean
    hasCapi: boolean
    id: Wid

    unique identifier for the group

    incognito: boolean
    isLidAddressingMode: boolean
    isParentGroup: boolean
    isParentGroupClosed: boolean
    lastActivityTimestamp: number
    lastSeenActivityTimestamp: number
    memberAddMode: string
    membershipApprovalMode: boolean
    membershipApprovalRequests: any[]
    noFrequentlyForwarded: boolean
    owner: Wid
    parentGroup: string

    serialized chat ID of the parent group (community)

    participants: { id: Wid; isAdmin: boolean; isSuperAdmin: boolean }[]

    Current members of the group. See pastParticipants for former members.

    pastParticipants: { id: Wid; leaveReason: "Left" | "Removed"; leaveTs: number }[]

    former members who left the group or were kicked out

    Type declaration

    • id: Wid
    • leaveReason: "Left" | "Removed"

      was leaving volumtary ("Left") or forceful ("Removed")

    • leaveTs: number

      UNIX timestamp in seconds of when the leaving occurred

    pendingParticipants: any[]

    members who applied for membership but still need admin approval

    reportToAdminMode: boolean
    restrict: boolean
    size: number

    current amount of members including admins

    subgroupSuggestions: any[]
    subject: string

    title/name of the group

    subjectTime: number
    support: boolean
    suspended: boolean
    terminated: boolean
    uniqueShortNameMap: Object

    Settings

    Member Visibility

    On This Page

    Properties