You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
153 lines
3.8 KiB
YAML
153 lines
3.8 KiB
YAML
GroupFullObject:
|
|
type: object
|
|
description: The response from an internal call to `Groups.get(<groupname>)`
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The group name
|
|
slug:
|
|
type: string
|
|
description: URL-safe slug of the group name
|
|
createtime:
|
|
type: number
|
|
description: UNIX timestamp of the group's creation
|
|
userTitle:
|
|
type: number
|
|
description: Label text for the user badge
|
|
userTitleEscaped:
|
|
type: number
|
|
description: Same as userTitle but with translation tokens escaped, used to display raw userTitle in group management
|
|
userTitleEnabled:
|
|
type: number
|
|
description:
|
|
type: string
|
|
description: The group description
|
|
memberCount:
|
|
type: number
|
|
hidden:
|
|
type: number
|
|
system:
|
|
type: number
|
|
private:
|
|
type: number
|
|
disableJoinRequests:
|
|
type: number
|
|
disableLeave:
|
|
type: number
|
|
nameEncoded:
|
|
type: string
|
|
displayName:
|
|
type: string
|
|
description: A custom override of the group's name, a friendly name
|
|
labelColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code
|
|
textColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code
|
|
memberPostCids:
|
|
type: string
|
|
memberPostCidsArray:
|
|
type: array
|
|
items:
|
|
type: number
|
|
example: [1, 2, 3]
|
|
icon:
|
|
type: string
|
|
description: A FontAwesome icon string
|
|
createtimeISO:
|
|
type: string
|
|
description: "`createtime` rendered as an ISO 8601 format"
|
|
cover:thumb:url:
|
|
type: string
|
|
cover:url:
|
|
type: string
|
|
cover:position:
|
|
type: string
|
|
descriptionParsed:
|
|
type: string
|
|
members:
|
|
type: array
|
|
items:
|
|
$ref: UserObject.yaml#/UserObjectSlim
|
|
membersNextStart:
|
|
type: number
|
|
pending:
|
|
type: array
|
|
invited:
|
|
type: array
|
|
isMember:
|
|
type: boolean
|
|
isPending:
|
|
type: boolean
|
|
isInvited:
|
|
type: boolean
|
|
isOwner:
|
|
type: boolean
|
|
nullable: true
|
|
GroupDataObject:
|
|
type: object
|
|
description: The response from an internal call to `Groups.getGroupsFields(<groupname>, [])` with **explicitly** no fields passed in
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: The group name
|
|
slug:
|
|
type: string
|
|
description: URL-safe slug of the group name
|
|
createtime:
|
|
type: number
|
|
description: UNIX timestamp of the group's creation
|
|
userTitle:
|
|
type: number
|
|
description: Label text for the user badge
|
|
userTitleEscaped:
|
|
type: number
|
|
description: Same as userTitle but with translation tokens escaped, used to display raw userTitle in group management
|
|
userTitleEnabled:
|
|
type: number
|
|
description:
|
|
type: string
|
|
description: The group description
|
|
memberCount:
|
|
type: number
|
|
hidden:
|
|
type: number
|
|
system:
|
|
type: number
|
|
private:
|
|
type: number
|
|
disableJoinRequests:
|
|
type: number
|
|
disableLeave:
|
|
type: number
|
|
cover:url:
|
|
type: string
|
|
cover:thumb:url:
|
|
type: string
|
|
nameEncoded:
|
|
type: string
|
|
displayName:
|
|
type: string
|
|
description: A custom override of the group's name, a friendly name
|
|
labelColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code
|
|
textColor:
|
|
type: string
|
|
description: A six-character hexadecimal colour code
|
|
icon:
|
|
type: string
|
|
description: A FontAwesome icon string
|
|
createtimeISO:
|
|
type: string
|
|
description: "`createtime` rendered as an ISO 8601 format"
|
|
cover:position:
|
|
type: string
|
|
memberPostCids:
|
|
type: string
|
|
memberPostCidsArray:
|
|
type: array
|
|
items:
|
|
type: number
|
|
example: [1, 2, 3] |