Versions Compared

Old Version 1

changes.mady.by.user Louis-Philippe Bell

Saved on

compared with

New Version Current

changes.mady.by.user Louis-Philippe Bell

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
← Previous

Next →

...

Panel
bgColorunset
Anchor
opalone._internal.boards.Board
opalone._internal.boards.Board
class opalone._internal.boards.Board(board_id, project_id, board_type=None)
Panel
bgColorunset

Bases: Resource, ABC

Base class for all boards. Cannot be instantiated, must use subclass.

Parameters:

  • board_id (str) – The ID of the board.

  • project_id (str) – The ID of the Project that owns this board.

  • board_type (BoardType) – The type of board.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.delete
opalone._internal.boards.Board.delete
delete()
Panel
bgColorunset

Delete the current board.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.to_json
opalone._internal.boards.Board.to_json
to_json(fields, values)
Panel
bgColorunset

Convert this resource to a serialized JSON representation.

Parameters:

  • fields (tuple[str] | list[str]) – Fields to include.

  • values (tuple[object] | list[object]) – The value of each field

Returns:

The serialized JSON representation.

Return type:

str

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.created_at
opalone._internal.boards.Board.created_at
property created_at: str
Panel
bgColorunset

The creation date of the board.

This property is read-only, it cannot be modified.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.description
opalone._internal.boards.Board.description
property description: str
Panel
bgColorunset

A description of the board.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.id
opalone._internal.boards.Board.id
property id: str
Panel
bgColorunset

The ID of the resource.

This property is read-only, it cannot be modified.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.modified_at
opalone._internal.boards.Board.modified_at
property modified_at: str
Panel
bgColorunset

The last-modified date of the board.

This property is read-only, it cannot be modified.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.name
opalone._internal.boards.Board.name
property name: str
Panel
bgColorunset

The name of the board.

The Board name must be unique within a group or within the root level of boards.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.order
opalone._internal.boards.Board.order
property order: int
Panel
bgColorunset

The order of this board within its group.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.parent
opalone._internal.boards.Board.parent
property parent: None | Group
Panel
bgColorunset

The parent Board that contains the current board.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.path
opalone._internal.boards.Board.path
property path: str
Panel
bgColorunset

The path of the board in the board tree.

This property is read-only, it cannot be modified.

Panel
bgColorunset
Anchor
opalone._internal.boards.Board.type
opalone._internal.boards.Board.type
property type: BoardType
Panel
bgColorunset

The type of the board.

This property is read-only, it cannot be modified.