Item Class¶
-
class
item.Item(itemJson, api)¶ This is the Item class.
-
allDay¶ Boolean to determine is the item is active all day.
Type: boolean
-
api= None¶
-
boxFolderID¶ The BoxFolderID value (read only).
Type: int
-
childID¶ The childID value. (read only).
Type: int
-
completed_by¶ The name of the user who has completed the item. (read only)
Type: string Note
The variable will be modified when an user set an item as completed
Note
None in case the item is not completed
-
completionDate¶ The date when the item was completed (read only).
Type: datetime Note
None in case the item is not completed
-
completionPercentage¶ The completion percentage value.
Type: int Warning
completionPercentage param must be greater than or equal to 0 and less than or equal to 100.
Note
If the completionPercentage is 100, the item will be set as completed.
-
creationDate¶ The date when the item was created (read only).
Type: datetime
-
delegate(username)¶ Delegate the item to the user with the specified username.
Parameters: owner_username (string) – The new name of the item’s owner
-
delegated_by¶ The user name who delegated the item (read only).
Type: string
-
descriptionText¶ The item description text.
Type: string
-
dueDate¶ The due date in case it exists.
Type: datetime
-
effort¶ The effort value of the item.
Type: int Warning
effort param must be greater than or equal to 0 and less than or equal to 10.
-
frequency¶ The item’s frequency.
Type: string. Warning
frequency value must be one the next list: “Never”, “Daily”, “Weekly”, “Biweekly”, “4-weekly”, “Monthly”, “Quaterly”, “Semesterly”, “Yearly” or “None”
-
getCreator¶ The user name of the item creator.
Type: string
-
getEdited_by_username¶ The last user’s name who edited the item (read only).
Type: string
-
getParentID¶ The Parent ID of the item (read only).
Type: int
-
id¶ The ID of the item (read only).
Type: int
-
idd¶ The idd of the item. (read only)
Type: int
-
isCompleted()¶ Returns if the item is completed or not.
Returns: True if the item is completed Returns: False if the item is not completed Return type: boolean
-
isDeleted()¶ Returns if the item is deleted or not.
Returns: True if the item has been deleted Returns: False if the item has not been deleted Return type: boolean
-
isDue()¶ Returns if the item is due or not.
Returns: True if the due date has passed Returns: False if the due date has not passed Return type: boolean
-
name¶ The name of the item.
Type: string
-
ownerUsername¶ The owner username of the item.
Type: string
-
projectID¶ The Project ID where the item is, in case it isn’t in the item box
Type: int Note
None in case the item is in item box
Note
The ID must belong to a created project
-
quadrant¶ The Quadrant where the item is.
Type: int Note
None in case the item doesn’t belong to a project yet
-
save()¶ Update the item with the changes made.
Note
If we have changed some value of the item, until we dont call to this function, it will not be saved on the API.
-
setAllDay¶ Boolean to determine is the item is active all day.
Type: boolean
-
setDescriptionText¶ The item description text.
Type: string
-
setEffort¶ The effort value of the item.
Type: int Warning
effort param must be greater than or equal to 0 and less than or equal to 10.
-
toString()¶ Returns a string with relevant information about the item.
-