Members
(private) _conn
Access to connection
- Source:
Inbox :List|undefined
Inbox list of the authenticated user
Type:
- List | undefined
- Source:
List
Access to List model
- Source:
lists
Access to Lists methods
- Source:
Reminder
Access to Reminder model
- Source:
Task
Access to Task model
- Source:
tasks
Access to Tasks methods
- Source:
user :Object
Information about the authenticated user
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
username |
string | Authenticated user's username |
id |
string | Account ID of the authenticated user |
pro |
boolean | Whether the authenticated user has a pro account |
- Source:
Methods
(private) _setUserInfo(userInfo)
Stores local information about the authenticated user
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userInfo |
Object | User Innformation
Properties
|
- Source:
changeCacheMaxAge(minutes)
Update the max age a cached object can have before being refreshed
Parameters:
| Name | Type | Description |
|---|---|---|
minutes |
Number | Maximum age in minutes |
- Source:
createReminder(quantity, unit) → {Reminder}
Creates a reminder object to be used when creating a Task. The reminder
will go off at {quantity} {units} before the date set for the Task.
If quantity equals to 0, an instant reminder will be returned
Parameters:
| Name | Type | Description |
|---|---|---|
quantity |
Number | Quantity of unit. |
unit |
Reminder.TimeUnit | Unit of time |
- Source:
Returns:
Reminder object that can be used to create a Task.
- Type
- Reminder
(async) login(options)
Authenticate with TickTick and store the session info for future calls.
This method must be called *before* any other.
Parameters:
| Name | Type | Description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Login options
Properties
|
- Source: