category_boards.go

TLDR

This file defines structs related to board categories and board metadata.

Classes

CategoryBoards

This class represents a board category and contains the following attributes:

• Category: an embedded struct representing the category details
• BoardMetadata: a list of CategoryBoardMetadata structs that contain board IDs and their hidden status
• SortOrder: the relative sort order of this board in its category

BoardCategoryWebsocketData

This class contains the data related to a board category in a websocket and includes the following attributes:

• BoardID: the ID of the board
• CategoryID: the ID of the category
• Hidden: a boolean indicating if the category is hidden or not

CategoryBoardMetadata

This class represents metadata for a board in a category and has the following attributes:

• BoardID: the ID of the board
• Hidden: a boolean indicating if the board is hidden or not

package model

const CategoryBoardsSortOrderGap = 10

// CategoryBoards is a board category and associated boards
// swagger:model
type CategoryBoards struct {
	Category

	// The IDs of boards in this category
	// required: true
	BoardMetadata []CategoryBoardMetadata `json:"boardMetadata"`

	// The relative sort order of this board in its category
	// required: true
	SortOrder int `json:"sortOrder"`
}

type BoardCategoryWebsocketData struct {
	BoardID    string `json:"boardID"`
	CategoryID string `json:"categoryID"`
	Hidden     bool   `json:"hidden"`
}

type CategoryBoardMetadata struct {
	BoardID string `json:"boardID"`
	Hidden  bool   `json:"hidden"`
}