mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4f8a3d571b
* Add Google APIs typings * [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors * versions should not get their own folders fixing a few typos using /** syntax so comments show up in editors export only actual (last) version for now * export only actual (last) version for now * merge namespaces and remove unnecessary namespace qualifiers * remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise * disable await-promise rule * fix collision between gapi.client.Request and Request from nested namespace disable no-irregular-whitespace rule * sort properties and namespace resources * remove empty comments sort resources amd methods in tests and readme.md * update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint use multiline comments when comment has several lines * implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules * add strictFunctionTypes to tsconfig * fix "Whitespace within parentheses is not allowed" rule * fix ts-lint rules * fixes * remove deprecated replicapool and replicapoolupdater api * fix no-irregular-whitespace * fix no-irregular-whitespace
2.6 KiB
2.6 KiB
TypeScript typings for Gmail API v1
Access Gmail mailboxes including sending user email. For detailed description please check documentation.
Installing
Install typings for Gmail API:
npm install @types/gapi.client.gmail@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('gmail', 'v1', () => {
// now we can use gapi.client.gmail
// ...
});
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 = [
// Read, send, delete, and manage your email
'https://mail.google.com/',
// Manage drafts and send emails
'https://www.googleapis.com/auth/gmail.compose',
// Insert mail into your mailbox
'https://www.googleapis.com/auth/gmail.insert',
// Manage mailbox labels
'https://www.googleapis.com/auth/gmail.labels',
// View your email message metadata such as labels and headers, but not the email body
'https://www.googleapis.com/auth/gmail.metadata',
// View and modify but not delete your email
'https://www.googleapis.com/auth/gmail.modify',
// View your email messages and settings
'https://www.googleapis.com/auth/gmail.readonly',
// Send email on your behalf
'https://www.googleapis.com/auth/gmail.send',
// Manage your basic mail settings
'https://www.googleapis.com/auth/gmail.settings.basic',
// Manage your sensitive mail settings, including who can manage your mail
'https://www.googleapis.com/auth/gmail.settings.sharing',
],
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 Gmail API resources:
/*
Gets the current user's Gmail profile.
*/
await gapi.client.users.getProfile({ userId: "userId", });
/*
Stop receiving push notifications for the given user mailbox.
*/
await gapi.client.users.stop({ userId: "userId", });
/*
Set up or update a push notification watch on the given user mailbox.
*/
await gapi.client.users.watch({ userId: "userId", });