The Google class is the entry point for accessing Google APIs in 4D NetKit. It is a facade that exposes three lazily-instantiated API clients:
mail — send, read, and manage Gmail messages and labelsuser — read Google user profiles (People API)calendar — manage Google calendars and eventsEach client is instantiated on first access and reused for subsequent calls.
These operations can be performed after a valid token request (see OAuth2Provider).
The Google class is instantiated by calling the cs.NetKit.Google.new() function.
Warning: Shared objects are not supported by the 4D NetKit API.
cs.NetKit.Google.new( oAuth2 : cs.NetKit.OAuth2Provider { ; param : Object } ) : cs.NetKit.Google
| Parameter | Type | Description | |
|---|---|---|---|
| oAuth2 | cs.NetKit.OAuth2Provider | -> | Object of the OAuth2Provider class |
| param | Object | -> | Additional options |
| Result | cs.NetKit.Google | <- | Object of the Google class |
cs.NetKit.Google.new() instantiates an object of the Google class.
In oAuth2, pass an OAuth2Provider object.
In param, you can pass an object that specifies the following options:
| Property | Type | Description |
|---|---|---|
| mailType | Text | Mail type used to send and receive emails. Possible values are: - “JMAP” (default) - “MIME” |
| userId | Text | User identifier, used to identify the user in Service mode. Can be the id or the userPrincipalName. Defaults to "me". |
The returned Google object exposes the following properties, each giving access to a dedicated API client:
| Property | Type | Description |
|---|---|---|
| GoogleMail | Gmail API client: send, read, delete, and manage messages and labels. | |
| user | GoogleUser | Google People API client: read user profiles. |
| calendar | GoogleCalendar | Google Calendar API client: manage calendars and events. |
To create the OAuth2 connection object and a Google object:
var $oAuth2 : cs.NetKit.OAuth2Provider
var $google : cs.NetKit.Google
$oAuth2:=New OAuth2 provider($param)
$google:=cs.NetKit.Google.new($oAuth2; {mailType: "MIME"})