Interface Group

Group type

Hierarchy

  • Group

Properties

additionalData? approvalStatus? created? description displayName groups? id imageUrl? name organization? state? stats title type? users?

Properties

Optional additionalData

additionalData?: StringIndexedObject

Non-standard additional data provided by the API.

Optional approvalStatus

approvalStatus?: string

The group's approval status

Optional created

created?: Date

When was the group created

description

description: string

A long-form description of the group

displayName

displayName: string

The group's full, human-readable display name

Optional groups

groups?: string[]

The groups this group belongs to

id

id: string

The group's id (usually a UUID)

Optional imageUrl

imageUrl?: string

The group's display image

name

name: string

The group's short name, often not human-readable

Optional organization

organization?: boolean

Is the group an organization

Optional state

state?: string

The group's state

stats

stats: {
    datasets?: number;
    followers?: number;
}

The group's numerical statistics

Type declaration

  • Optional datasets?: number
  • Optional followers?: number

title

title: string

The group's full title

Optional type

type?: string

The group's type

Optional users

users?: User[]

The group's members

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc