GContacts Component

Properties Methods Events Configuration Settings Errors

The GContacts component implements the Google Contact Data API.

Syntax

nsoftware.InGoogle.Gcontacts

Remarks

GContacts allows you to easily list, create, update or delete contacts in your Google account.

Before using the component you must have a valid Google account.

Once you have a valid Google account, set the User and Password to your e-mail address and password before calling any of the methods. To obtain details of all of the contacts associated with your account call QueryContacts. To view the details of a specific contact set ContactIndex and check the desired property such as FirstName. For a full list of properties that are populated when ContactIndex is set, see the help section for ContactIndex.

The component has additional methods such as CreateContact, DeleteContact, and UpdateContact to allow you to further manage your contacts.

This service supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

Assign this value to the Authorization property before attempting any operations. Consult the Google documentation for this particular service for more information about supported scope values and more details on OAuth authentication.

Alternatively, this service also supports Client Login authentication by setting the User and Password configuration settings.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


Authorization	OAuth 2.0 Authorization Token.
Birthday	The Birthday of the current contact in a Google Contacts feed.
ContactCount	The number of contacts contained within a Google Contacts feed.
ContactEditURL	The Edit URL of the current contact in a Google Contacts feed.
ContactETag	The ETag of the current contact in a Google Contacts feed.
ContactIndex	The index of the current contact in a Google Contacts feed.
ContactProperties	A collection of properties for the current Google contact.
Cookies	Collection of cookies.
Deleted	Specifies whether the contact has been deleted.
FeedProperties	The feed elements of a Google Data feed.
FeedURL	The URL of a Google Contacts feed.
Firewall	A set of properties related to firewall access.
FirstName	The First Name of the current contact in a Google Contacts feed.
FullName	The Full Name of the current contact in a Google Contacts feed.
Gender	The Gender of the current contact in a Google Contacts feed.
HomeAddress	The Home Address of the current contact in a Google Contacts feed.
HomeEmailAddress	The Home Email Address of the current contact in a Google Contacts feed.
HomeIMAddress	The Home IM Address of the current contact in a Google Contacts feed.
HomeIMProtocol	The Home IM Protocol of the current contact in a Google Contacts feed.
HomePhoneNumber	The Home Phone Number of the current contact in a Google Contacts feed.
HomeWebsite	The Home Website URL of the current contact in a Google Contacts feed.
Idle	The current status of the component.
LastName	The Last Name of the current contact in a Google Contacts feed.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MobilePhoneNumber	The Mobile Phone Number of the current contact in a Google Contacts feed.
Nickname	The Nickname of the current contact in a Google Contacts feed.
Notes	The Notes for the current contact in a Google Contacts feed.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last request.
Proxy	A set of properties related to proxy access.
QueryParams	Addtional query parameters to be included in the request.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the component.
WorkAddress	The Work Address of the current contact in a Google Contacts feed.
WorkEmailAddress	The Work Email Address of the current contact in a Google Contacts feed.
WorkIMAddress	The Work IM Address of the current contact in a Google Contacts feed.
WorkIMProtocol	The Work IM Protocol of the current contact in a Google Contacts feed.
WorkPhoneNumber	The Work Phone Number of the current contact in a Google Contacts feed.
WorkWebsite	The Work Website URL of the current contact in a Google Contacts feed.
XAttributes	A collection of attributes of the current element.
XChildren	Collection of child elements of the current element.
XElement	The name of the current element.
XNamespace	The namespace of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the document.
XPrefix	The prefix of the current element.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


AddQueryParam	Adds a query parameter to the QueryParams properties.
Config	Sets or retrieves a configuration setting .
CreateContact	Creates a new contact within the specified Google Contacts feed.
DeleteContact	Deletes a contact within a Google Contacts feed.
GetProperty	Get the value of a specific Google Data feed element or attribute.
QueryContacts	Queries a Google Contacts feed using the specified parameters.
Reset	Reset all properties of the component.
UpdateContact	Update a Google contact.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ContactList	This event fires once for each contact returned when calling QueryContacts.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
SetCookie	Fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


BlogWebsite	The Blog Website URL of the current contact in a Google Contacts feed.
CreateGroup	Creates a new contact group within the specified Google Contact Group feed.
DeleteGroup	Deletes a contact group within the specified Google Contact Group feed.
Id	The Id element value of the current contact in a Google Contacts feed.
GetGroupId	Returns the GroupId for a given contacts group.
GroupCount	The number of contact groups contained within a Google Contact Group feed.
GroupIndex	The index of the current contact group in a Google Contact Group feed.
GroupId	The Id of the current contact group in a Google Contact Group feed.
GroupETag	The ETag of the current contact group in a Google Contact Group feed.
GroupTitle	The title of the current contact group in a Google Contact Group feed.
GroupEditURL	The Edit URL of the current contact group in a Google Contact Group feed.
NamePrefix	The Prefix value for a name in a Google Contacts feed.
NameSuffix	The Suffix value for a name in a Google Contacts feed.
Occupation	The Occupation of the current contact in a Google Contacts feed.
ProfileWebsite	The Profile Website URL of the current contact in a Google Contacts feed.
QueryGroups	Queries a Google Contact Group feed.
Title	The Title element value of the current contact in a Google Contacts feed.
Updated	The last time the current contact in a Google Contacts feed was updated.
UpdateGroup	Updates a Google Contact Group.
AccountType	The type of account to request authorization for.
CaptchaToken	The token received from Google during a CAPTCHA challenge.
CaptchaURL	The image URL received from Google during a CAPTCHA challenge.
CaptchaValue	The value given by the person responding to the CAPTCHA challenge.
DateFormat	The format string to be used for formatting the DateTime values received from the server.
NameAndEmailFormat	Determines how the data of the name and e-mail properties will be formatted.
Source	The source parameter value for Google ClientLogin.
TransferredData	The contents of the last response from the server.
TransferredHeaders	The full set of headers as received from the server.
ServiceName	The name of the Google Data service.
User	The user's email address used for Client Login authentication.
Password	The user's password used for Client Login authentication.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.