Skip to main content

api.project.project_exporters_commands

ListProjectExportersCommand Objects​

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

Command to fetch all project exporters.

Notes:

Requires a ListProjectExportersReply reply.

build​

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

Helper function to easily build this message.

ListProjectExportersReply Objects​

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

Reply to ListProjectExportersCommand.

Arguments:

  • exporters - List of all project exporters.

build​

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

Helper function to easily build this message.

ExportProjectCommand Objects​

@Message.define("command/project/export")
class ExportProjectCommand(Command)

Command to export a project.

Notes:

Requires an ExportProjectReply reply.

build​

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

Helper function to easily build this message.

ExportProjectReply Objects​

@Message.define("command/project/export/reply")
class ExportProjectReply(CommandReply)

Reply to ExportProjectCommand.

Arguments:

  • mimetype - The MIME type of the export result.

data​

@property
def data() -> bytes | None

The data of the export result.

Returns:

The binary data of the export result.

data​

@data.setter
def data(data: bytes) -> None

Sets the data of the export result.

Arguments:

  • data - The export result data.

build​

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

Helper function to easily build this message.