Skip to main content

api.project.project_commands

ListProjectsCommand Objects​

@Message.define("command/project/list")
class ListProjectsCommand(Command)

Command to fetch all projects of the current user.

Notes:

Requires a ListProjectsReply reply.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          chain: Message | None = None) -> CommandComposer

Helper function to easily build this message.

ListProjectsReply Objects​

@Message.define("command/project/list/reply")
class ListProjectsReply(CommandReply)

Reply to ListProjectsCommand.

Arguments:

  • projects - List of all projects.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          cmd: ListProjectsCommand,
          *,
          projects: typing.List[Project],
          success: bool = True,
          message: str = "") -> CommandReplyComposer

Helper function to easily build this message.

CreateProjectCommand Objects​

@Message.define("command/project/create")
class CreateProjectCommand(Command)

Command to create a new project.

Arguments:

  • resources_path - The resources path of the project.
  • title - The title of the project.
  • description - An optional project description.
  • options - The project options.

Notes:

Requires a CreateProjectReply reply.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          resources_path: str,
          title: str,
          description: str,
          options: Project.Options,
          chain: Message | None = None) -> CommandComposer

Helper function to easily build this message.

CreateProjectReply Objects​

@Message.define("command/project/create/reply")
class CreateProjectReply(CommandReply)

Reply to CreateProjectCommand.

Arguments:

  • project_id - The ID of the created project.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          cmd: CreateProjectCommand,
          *,
          project_id: ProjectID,
          success: bool = True,
          message: str = "") -> CommandReplyComposer

Helper function to easily build this message.

UpdateProjectCommand Objects​

@Message.define("command/project/update")
class UpdateProjectCommand(Command)

Command to update an existing project. Note that the project features are updated using a separate UpdateProjectFeaturesCommand message.

Arguments:

  • project_id - The ID of the project to update.
  • title - The title of the project.
  • description - An optional project description.
  • options - The project options.

Notes:

Requires an UpdateProjectReply reply.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          project_id: ProjectID,
          title: str,
          description: str,
          options: Project.Options,
          chain: Message | None = None) -> CommandComposer

Helper function to easily build this message.

UpdateProjectReply Objects​

@Message.define("command/project/update/reply")
class UpdateProjectReply(CommandReply)

Reply to UpdateProjectCommand.

Arguments:

  • project_id - The ID of the updated project.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          cmd: UpdateProjectCommand,
          *,
          project_id: ProjectID,
          success: bool = True,
          message: str = "") -> CommandReplyComposer

Helper function to easily build this message.

MarkProjectLogbookSeenCommand Objects​

@Message.define("command/project/logbook/mark-seen")
class MarkProjectLogbookSeenCommand(Command)

Marks a project logbook entry as seen.

Arguments:

  • logbook_type - The logbook type to mark.
  • project_id - The ID of the project containing the logbook.
  • record - The record ID.
  • mark_all - If true, all records will be marked as seen (ignores project and record IDs).

Notes:

Requires a ProjectLogbookMarkSeenReply reply.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          logbook_type: ProjectLogbookType,
          project_id: ProjectID,
          record: RecordID,
          mark_all: bool = False,
          chain: Message | None = None) -> CommandComposer

Helper function to easily build this message.

MarkProjectLogbookSeenReply Objects​

@Message.define("command/project/logbook/mark-seen/reply")
class MarkProjectLogbookSeenReply(CommandReply)

Reply to ProjectLogbookMarkSeenCommand.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          cmd: MarkProjectLogbookSeenCommand,
          *,
          success: bool = True,
          message: str = "") -> CommandReplyComposer

Helper function to easily build this message.

DeleteProjectCommand Objects​

@Message.define("command/project/delete")
class DeleteProjectCommand(Command)

Command to delete a project of the current user.

Arguments:

  • project_id - The ID of the project to delete.

Notes:

Requires a DeleteProjectReply reply.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          *,
          project_id: ProjectID,
          chain: Message | None = None) -> CommandComposer

Helper function to easily build this message.

DeleteProjectReply Objects​

@Message.define("command/project/delete/reply")
class DeleteProjectReply(CommandReply)

Reply to DeleteProjectCommand.

Arguments:

  • project_id - The ID of the deleted project.

build​

@staticmethod
def build(message_builder: MessageBuilder,
          cmd: DeleteProjectCommand,
          *,
          project_id: ProjectID,
          success: bool = True,
          message: str = "") -> CommandReplyComposer

Helper function to easily build this message.