Class: Lists

Services~Lists()

Lists Service

Constructor

new Lists()

Source:

Members

(private) _listsCache :Object.<string, List>

Object with cached user lists where the key is the name of the list
Type:
  • Object.<string, List>
Source:

(private) _listsCacheLastUpdate :Date

Last time TickTick#_listsCache was updated
Type:
  • Date
Source:

Methods

(async, private) _checkListsCache()

Verify if the current lists cache has not expired. If it has expired, it will update TickTick's list properties
Source:

(private) _refreshCache()

Verify if the current lists cache has not expired. If it has expired, it will update TickTick's list properties
Source:

(async) getAll(forceRefreshopt) → {Object.<string, List>}

Gets a map of all lists available to the authenticated user
Parameters:
Name Type Attributes Description
forceRefresh boolean <optional>
 Whether to force a refresh of the cached lists
Source:
Returns:
Object with cached user lists where the key is the name of the list
Type
Object.<string, List>

(async) getByName(name, forceRefreshopt) → {List|undefined}

Gets a list with a specific name
Parameters:
Name Type Attributes Description
name string The name of the list
forceRefresh boolean <optional>
 Whether to force a refresh of the cached lists
Source:
Returns:
} List object or undefined if a list with the provided name does not exist
Type
List | undefined