DefinitelyTyped/types/gapi.client.tasks/readme.md

TypeScript typings for Tasks API v1

Lets you manage your tasks and task lists. For detailed description please check documentation.

Installing

Install typings for Tasks API:

npm install @types/gapi.client.tasks@v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load("client", () => { 
    // now we can use gapi.client
    // ... 
});

Then load api client wrapper:

gapi.client.load('tasks', 'v1', () => {
    // now we can use gapi.client.tasks
    // ... 
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
    scope = [     
        // Manage your tasks
        'https://www.googleapis.com/auth/tasks',
    
        // View your tasks
        'https://www.googleapis.com/auth/tasks.readonly',
    ],
    immediate = true;
// ...

gapi.auth.authorize({ client_id: client_id, scope: scope, immediate: immediate }, authResult => {
    if (authResult && !authResult.error) {
        /* handle succesfull authorization */
    } else {
        /* handle authorization error */
    }
});            

After that you can use Tasks API resources:

    
/* 
Deletes the authenticated user's specified task list.  
*/
await gapi.client.tasklists.delete({ tasklist: "tasklist",  }); 
    
/* 
Returns the authenticated user's specified task list.  
*/
await gapi.client.tasklists.get({ tasklist: "tasklist",  }); 
    
/* 
Creates a new task list and adds it to the authenticated user's task lists.  
*/
await gapi.client.tasklists.insert({  }); 
    
/* 
Returns all the authenticated user's task lists.  
*/
await gapi.client.tasklists.list({  }); 
    
/* 
Updates the authenticated user's specified task list. This method supports patch semantics.  
*/
await gapi.client.tasklists.patch({ tasklist: "tasklist",  }); 
    
/* 
Updates the authenticated user's specified task list.  
*/
await gapi.client.tasklists.update({ tasklist: "tasklist",  }); 
    
/* 
Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.  
*/
await gapi.client.tasks.clear({ tasklist: "tasklist",  }); 
    
/* 
Deletes the specified task from the task list.  
*/
await gapi.client.tasks.delete({ task: "task", tasklist: "tasklist",  }); 
    
/* 
Returns the specified task.  
*/
await gapi.client.tasks.get({ task: "task", tasklist: "tasklist",  }); 
    
/* 
Creates a new task on the specified task list.  
*/
await gapi.client.tasks.insert({ tasklist: "tasklist",  }); 
    
/* 
Returns all tasks in the specified task list.  
*/
await gapi.client.tasks.list({ tasklist: "tasklist",  }); 
    
/* 
Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.  
*/
await gapi.client.tasks.move({ task: "task", tasklist: "tasklist",  }); 
    
/* 
Updates the specified task. This method supports patch semantics.  
*/
await gapi.client.tasks.patch({ task: "task", tasklist: "tasklist",  }); 
    
/* 
Updates the specified task.  
*/
await gapi.client.tasks.update({ task: "task", tasklist: "tasklist",  });