mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-06 20:37:49 +00:00
57 lines
2.7 KiB
Markdown
57 lines
2.7 KiB
Markdown
# Badge
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { Badge } from "@lukehagar/discoursejs/sdk/models/operations";
|
|
|
|
let value: Badge = {
|
|
allowTitle: false,
|
|
autoRevoke: false,
|
|
badgeGroupingId: 678880,
|
|
badgeTypeId: 118274,
|
|
description: "Re-contextualized motivating leverage",
|
|
enabled: false,
|
|
grantCount: 143353,
|
|
icon: "<value>",
|
|
id: 537373,
|
|
imageUrl: "<value>",
|
|
listable: false,
|
|
longDescription: "<value>",
|
|
manuallyGrantable: false,
|
|
multipleGrant: false,
|
|
name: "<value>",
|
|
query: "<value>",
|
|
showPosts: false,
|
|
slug: "<value>",
|
|
system: false,
|
|
targetPosts: false,
|
|
trigger: "<value>",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------- | ------------------- | ------------------- | ------------------- |
|
|
| `allowTitle` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `autoRevoke` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `badgeGroupingId` | *number* | :heavy_check_mark: | N/A |
|
|
| `badgeTypeId` | *number* | :heavy_check_mark: | N/A |
|
|
| `description` | *string* | :heavy_check_mark: | N/A |
|
|
| `enabled` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `grantCount` | *number* | :heavy_check_mark: | N/A |
|
|
| `icon` | *string* | :heavy_check_mark: | N/A |
|
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
|
| `imageUrl` | *string* | :heavy_check_mark: | N/A |
|
|
| `listable` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `longDescription` | *string* | :heavy_check_mark: | N/A |
|
|
| `manuallyGrantable` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `multipleGrant` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `name` | *string* | :heavy_check_mark: | N/A |
|
|
| `query` | *string* | :heavy_check_mark: | N/A |
|
|
| `showPosts` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `slug` | *string* | :heavy_check_mark: | N/A |
|
|
| `system` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `targetPosts` | *boolean* | :heavy_check_mark: | N/A |
|
|
| `trigger` | *string* | :heavy_check_mark: | N/A | |