Codecore Logo
Quick Search
»
Advanced Search »

Google Contacts Driver

RSS
This driver is used to retrieve contacts from a Google Contacts account.

Manufacturer: Google

Primary Communications Port: Network


Configuration Settings

  • Username : Username for Google Contacts account.
  • Password : Password for Google Contacts account.
  • Reload Interval : (optional) Interval in seconds to Reload Contacts.

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Instance Properties

PhoneContacts

Gets an array of Contact objects that have a phone number.

Accessibility : Read Only

Type: Array

EmailContacts

Gets an array of Contact objects that have an email address.

Accessibility : Read Only

Type: Array

AllContacts

Gets an array of all the Contact objects.

Accessibility : Read Only

Type: Array

LastReloadContactCount

Gets the total number of contact records retrieved from Google at the last successul reload. The is for informational purposes only. Do not use this property when enumerating contacts.

Accessibility : Read Only

Type: Number

LastReloadDateTime

Gets the date/time of the last successful reload of the contacts.

Accessibility : Read Only

Type: DateTime

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

GetByPhoneNumber ( String )

Gets the contacts having the specified phone number.

Syntax

Array GetByPhoneNumber( String phoneNumber )

Parameters

phoneNumber : The Phone Number to get contact for.

GetByEmailAddress ( String )

Gets the contacts having the specified email address.

Syntax

Array GetByEmailAddress( String emailAddress )

Parameters

emailAddress : The Email Address to get contact for.

ReloadContacts

Reloads the contacts from Google.

Syntax

void ReloadContacts( )

Parameters

none

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.