Type Alias GroupData

GroupData: {
    abilities?: string[];
    avatar?: string;
    defaultPrimary?: boolean;
    defaultSecondary?: boolean;
    email?: string;
    enabled?: boolean;
    groupname?: string;
    name?: string;
    parent?: Group & GroupData;
    phone?: string;
    unverifiedSecondary?: boolean;
    user?: User & UserData | null;
}

Type declaration

  • Optionalabilities?: string[]

    The abilities granted to the group.

  • Optionalavatar?: string

    The group's avatar URL. (Use getAvatar() to support Gravatar.)

  • OptionaldefaultPrimary?: boolean

    Whether this group is the default primary group for new users.

  • OptionaldefaultSecondary?: boolean

    Whether this group is a default secondary group for new users.

  • Optionalemail?: string

    The group's email address.

  • Optionalenabled?: boolean

    Whether the group can be used.

  • Optionalgroupname?: string

    The group's groupname.

  • Optionalname?: string

    The group's name.

  • Optionalparent?: Group & GroupData

    The group's parent.

  • Optionalphone?: string

    The group's telephone number.

  • OptionalunverifiedSecondary?: boolean

    Whether this group is a default secondary group for unverified users.

  • Optionaluser?: User & UserData | null

    If generatePrimary is on, this will be the user who generated this group.

Settings

Member Visibility