@sudoplatform/sudo-secure-communications
    Preparing search index...

    Interface Group

    The Sudo Platform SDK representation of a Group. Model for a wrapper around a messaging group with extra fields for discoverability and customization.

    Group

    interface Group {
        avatarUrl?: string;
        description?: string;
        groupId: GroupId;
        inviter?: Handle;
        memberCount: number;
        name?: string;
        permissions?: GroupPermissions;
    }
    Index

    Properties

    avatarUrl? description? groupId inviter? memberCount name? permissions?

    Properties

    avatarUrl?: string

    Optional url for associated avatar image.

    description?: string

    Optional explanation about what the group is about.

    groupId: GroupId

    Unique identifier of the group.

    inviter?: Handle

    Optional handle of the inviter.

    memberCount: number

    The number of joined members of the group.

    name?: string

    Optional display name for the group.

    permissions?: GroupPermissions

    Optional permissions describing what roles can perform certain actions within the group.

    Settings

    Member Visibility

    On This Page

    Properties