coretex.coretex.space.base.BaseObject Class Reference

Inheritance diagram for coretex.coretex.space.base.BaseObject:

Public Member Functions
bool	rename (self, str name)
bool	updateDescription (self, str description)

Detailed Description

    Represents the base class for Space/Project objects from Coretex.ai

    Properties
    ----------
    name : str
        name of object
    description : Optional[str]
        description of object
    createdOn : datetime
        date of creation of object
    createdById : str
        id of user that created object
    spaceTask : SpaceTask
        space task of created object

Definition at line 26 of file base.py.

Member Function Documentation

rename()

bool coretex.coretex.space.base.BaseObject.rename	(		self,
		str	name
	)

    Renames the Space/Project

    Parameters
    ----------
    name : str
new name

    Returns
    -------
    bool -> True if Space/Project was renamed, False if Space/Project was not renamed

Definition at line 62 of file base.py.

    def rename(self, name: str) -> bool:
        """
            Renames the Space/Project
 
            Parameters
            ----------
            name : str
                new name
 
            Returns
            -------
            bool -> True if Space/Project was renamed, False if Space/Project was not renamed
        """
 
        if self.name == name:
            return False
 
        success = self.update(
            parameters = {
                "name": name
            }
        )
 
        if success:
            self.name = name
 
        return success
 

updateDescription()

bool coretex.coretex.space.base.BaseObject.updateDescription	(		self,
		str	description
	)

    Updates the Space/Project's description

    Parameters
    ----------
    description : str
new description

    Returns
bool -> True if Space/Project's description was updated,
False if Space/Project's description was not updated

Definition at line 90 of file base.py.

    def updateDescription(self, description: str) -> bool:
        """
            Updates the Space/Project's description
 
            Parameters
            ----------
            description : str
                new description
 
            Returns
                bool -> True if Space/Project's description was updated,
                False if Space/Project's description was not updated
        """
 
        if self.description == description:
            return False
 
        success = self.update(
            parameters = {
                "description": description
            }
        )
 
        if success:
            self.description = description
 
        return success

---

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

• src/coretex/coretex/space/base.py