mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-06 20:37:49 +00:00
72 lines
4.6 KiB
Markdown
72 lines
4.6 KiB
Markdown
# BasicGroup
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { BasicGroup } from "@lukehagar/discoursejs/sdk/models/operations";
|
|
|
|
let value: BasicGroup = {
|
|
allowMembershipRequests: false,
|
|
automatic: false,
|
|
bioCooked: "<value>",
|
|
bioExcerpt: "<value>",
|
|
bioRaw: "<value>",
|
|
canAdminGroup: false,
|
|
canSeeMembers: false,
|
|
defaultNotificationLevel: 414369,
|
|
flairBgColor: "<value>",
|
|
flairColor: "<value>",
|
|
flairUrl: "<value>",
|
|
fullName: "Nellie Frami",
|
|
grantTrustLevel: "<value>",
|
|
hasMessages: false,
|
|
id: 338007,
|
|
incomingEmail: "<value>",
|
|
membersVisibilityLevel: 110375,
|
|
membershipRequestTemplate: "<value>",
|
|
mentionableLevel: 674752,
|
|
messageableLevel: 656330,
|
|
name: "<value>",
|
|
primaryGroup: false,
|
|
publicAdmission: false,
|
|
publicExit: false,
|
|
publishReadState: false,
|
|
title: "<value>",
|
|
userCount: 317202,
|
|
visibilityLevel: 138183,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
|
| `allowMembershipRequests` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `automatic` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `bioCooked` | *string* | :heavy_check_mark: | N/A |
|
|
| `bioExcerpt` | *string* | :heavy_check_mark: | N/A |
|
|
| `bioRaw` | *string* | :heavy_check_mark: | N/A |
|
|
| `canAdminGroup` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `canEditGroup` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `canSeeMembers` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `defaultNotificationLevel` | *number* | :heavy_check_mark: | N/A |
|
|
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
|
|
| `flairColor` | *string* | :heavy_check_mark: | N/A |
|
|
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
|
|
| `fullName` | *string* | :heavy_check_mark: | N/A |
|
|
| `grantTrustLevel` | *string* | :heavy_check_mark: | N/A |
|
|
| `hasMessages` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
|
| `incomingEmail` | *string* | :heavy_check_mark: | N/A |
|
|
| `membersVisibilityLevel` | *number* | :heavy_check_mark: | N/A |
|
|
| `membershipRequestTemplate` | *string* | :heavy_check_mark: | N/A |
|
|
| `mentionableLevel` | *number* | :heavy_check_mark: | N/A |
|
|
| `messageableLevel` | *number* | :heavy_check_mark: | N/A |
|
|
| `name` | *string* | :heavy_check_mark: | N/A |
|
|
| `primaryGroup` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `publicAdmission` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `publicExit` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `publishReadState` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `title` | *string* | :heavy_check_mark: | N/A |
|
|
| `userCount` | *number* | :heavy_check_mark: | N/A |
|
|
| `visibilityLevel` | *number* | :heavy_check_mark: | N/A | |