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

  • Optional abilities?: string[]

    The abilities granted to the group.

  • Optional avatar?: string

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

  • Optional defaultPrimary?: boolean

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

  • Optional defaultSecondary?: boolean

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

  • Optional email?: string

    The group's email address.

  • Optional enabled?: boolean

    Whether the group can be used.

  • Optional groupname?: string

    The group's groupname.

  • Optional name?: string

    The group's name.

  • Optional parent?: Group & GroupData

    The group's parent.

  • Optional phone?: string

    The group's telephone number.

  • Optional unverifiedSecondary?: boolean

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

  • Optional user?: User & UserData | null

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

Settings

Member Visibility

Theme

Generated using TypeDoc