Documentation AddressBook Importer DLL version 4.0

AutoUpdate DLL

Parameters

AddressBook Importer

Reference

• Add reference to stescodes.dll from your project bin folder
• Import the namespace "stescodes"

Settings

Add the below appsettings on your web.config file

    <add key="gmailapikey" value="Your gmail consumer or api key"/>
    <add key="gmailapisecret" value="Your gmail consumer or api secret key"/>

    <add key="consumerKey_yahoo" value="Your yahoo consumer or api key"/>
    <add key="consumerSecret_yahoo" value="Your yahoo consumer or api secret key"/>

    <add key="liveapiKey" value="Your live consumer or api key"/>
    <add key="livesecretKey" value="Your live consumer or api secret key"/>
            

Direct method

Function

GrabContacts(<servicename>, <your email>, <your password>, this.context);

Parameters for Direct method

Return Type

1. Email
2. Name
3. Address
4. Phone

OAuth method

To start grabbing contacts using OAuth Method, you have to make request to three functions

1. GetAuthenticationUrl
2. GetAccessToken
3. GrabContacts_OAuth

To configure API keys in Gmail, Yahoo and Windows Live, click here How to configure API keys.

Function for GetAuthenticationUrl function

GetAuthenticationUrl(servicename, ConsumerKey, ConsumerSecret, callbackurl, policyurl);

Parameters

Return type

1. Token
2. TokenSecret
3. UID
4. AuthURL

Function for GetAccessToken function

GetAccessToken(servicename, ConsumerKey, ConsumerSecret, callbackurl, token, tokensecret, tokenverifier);

Parameters

Return type

1. Token
2. TokenSecret
3. UID
4. AuthURL

Function for GrabContacts_OAuth function

GrabContacts_OAuth(servicename, token, tokensecret, tokenverifier, UID, ConsumerKey, ConsumerSecret, this.context);

Parameters

Return Types

1. Email
2. Name
3. Address
4. Phone

Debugging

Debugging Gmail:

1. Create API key with the localhost url as return url(when going live, change the return url to live url)
2. Replace the api key and secret key in web.config file
3. Replace the already provided localhost url in oauth.aspx.cs file
4. Then try with breakpoints to debug

Debugging Yahoo:

1. Create API key with the localhost url as return url(when going live, change the return url to live url)
2. Replace the api key and secret key in web.config file
3. Then try with breakpoints to debug

Debugging Windows Live:

1. Upload the auth.aspx page to your server.
2. Do the below five steps when the user is redirected after authentication.
3. Get the post data and construct as a url with querystring parameter(for ex: token=xxx&tokensecret=yyyy as http://youdomain.com/auth.aspx?token=xxx&tokensecret=yyyy)
4. After constructing the parameter change the constructed url to localhost url(for ex: http://youdomain.com/auth.aspx?token=xxx&tokensecret=yyyy to http://localhost:2345/yourproject/auth.aspx?token=xxx&tokensecret=yyyy
5. Redirect to the localhost url(for ex: Response.Redirect(http://localhost:2345/yourproject/auth.aspx?token=xxx&tokensecret=yyyy);)
6. Now you will get the token in localhost for debugging.
7. Remove the redirection part after you done with your debugging.

Binding

Error Handling

Error Message

Configurations

Inorder to perform the autoupdate process successfully, your project should be read/write enabled. Once found update, two files will be updated, one is stescodes.dll which is inside bin folder and other is stescodes.im which is outside the bin folder. The stescodes.im file has the details of update info.

If you don't want to provide write permission for the entire project, then follow the below steps:

• Create a folder with write permission or specify a folder with write permission for IMfile
• Pass the location of folder to "checkforupdate" function as fourth parameter(eg: checkforupdate(this.Context, signature,bin location,IMfile location);)
• Also specify the path as additional parameter to "grabContacts"(specify as third parameter) function

Permissions

Turn On/Off AutoUpdate

Turn OFF:

In order to turn off autoupdate, login to http://stescodes.com/sourceupdate.aspx then click OFF button. Once autoupdate is set OFF, the DLL with latest updates will not be updated on your server automatically, you have to manually update by downloading the latest DLL from customer login. No need to providing write permission for bin folder.

Even though you turn OFF the autoupdate feature, you should have the below on your project.

• Either you should create a folder with write permission OR provide write permission to root folder. This process is necessary for the stescodes.im file to be created which keeps track of the service validations.
• If you create a folder with write permission then specify that location as parameter for "autoupdate" function and "grabContacts" function(refer above for passing parameter).

Turn ON:

In order to turn ON autoupdate, login to http://stescodes.com/sourceupdate.aspx then click ON button. Once autoupdate is set ON, the DLL with latest updates will be updated on your server automatically.

If you turn ON the autoupdate feature, you should have the below on your project

• Either you should create a folder with write permission OR provide write permission to root folder.
• If you create a folder with write permission then specify that location as parameter for "autoupdate" function and "grabContacts" function(refer above for passing parameter).

Change Domain

Edit/Change Domain

• Login to http://stescodes.com/sourceupdate.aspx
• You shall login using email and password which you received in email during purchase or you shall use the StesCodes transaction id
• Once you login, click the edit link near website
• Enter the domain details
• Click "proceed" to save.