coretex.entities.project.task.Task Class Reference

Inheritance diagram for coretex.entities.project.task.Task:

Public Member Functions
Optional[Self]	createTask (cls, str name, int projectId, Optional[str] description=None)
Public Member Functions inherited from coretex.entities.project.base.BaseObject
bool	rename (self, str name)
bool	updateDescription (self, str description)

Detailed Description

    Represents the task entity from Coretex.ai\n
    Contains properties that describe the task

Definition at line 26 of file task.py.

Member Function Documentation

createTask()

Optional[Self] coretex.entities.project.task.Task.createTask	(		cls,
		str	name,
		int	projectId,
		Optional[str]	description = None
	)

    Creates a new task with the provided name and description
    Task is added to the project with provided project id

    Parameters
    ----------
    name : str
        task name
    projectId : int
        project id the task belongs to
    description : Optional[str]
        task description

    Returns
    -------
    Optional[Self] -> The created task object

    Example
    -------
    >>> from coretex import Task
    \b
    >>> dummyTask = Task.createTask(
            name = "dummyTask",
            projectId = 23,
            description = "This is dummy task"
        )
    >>> if dummyTask is None:
            print("Failed to create task")

Definition at line 44 of file task.py.

    def createTask(cls, name: str, projectId: int, description: Optional[str]=None) -> Optional[Self]:
        """
            Creates a new task with the provided name and description
            Task is added to the project with provided project id
 
            Parameters
            ----------
            name : str
                task name
            projectId : int
                project id the task belongs to
            description : Optional[str]
                task description
 
            Returns
            -------
            Optional[Self] -> The created task object
 
            Example
            -------
            >>> from coretex import Task
            \b
            >>> dummyTask = Task.createTask(
                    name = "dummyTask",
                    projectId = 23,
                    description = "This is dummy task"
                )
            >>> if dummyTask is None:
                    print("Failed to create task")
        """
 
        if not isEntityNameValid(name):
            raise ValueError(">> [Coretex] Task name is invalid. Requirements: alphanumeric characters (\"a-z\", and \"0-9\") and dash (\"-\") with length between 3 to 50")
 
        return cls.create(
            name = name,
            parent_id = projectId,
            description = description
        )

---

The documentation for this class was generated from the following file:

• coretex/entities/project/task.py