Documentation of Friends Inviter version 4.0

AutoUpdate DLL

Parameters

Friends Inviter

Reference

• Add reference to StesCodes_sfi.dll
• Import the namespace "StesCodes_FriendsInviter"

• Add reference to StesCodes_fi.dll from
• Import the namespace "stescodes_FI"
• Include the "canvas.html" and "rpc_relay.html" in your root directory for Google Friends Connect

Settings

Add the below appsettings on your web.config file only for Plan D

    <add key="TwApiKey" value="Enter your Twitter consumer key"/>
    <add key="TwSecretKey" value="Enter your Twitter consumer secret key"/>
    <add key="LnApiKey" value="Enter your LinkedIn API key" />
    <add key="LnSecretKey" value="Enter your LinkedIn Secret Key" />
    <add key="FbAppId" value="Enter your Facebook APP ID" />
    <add key="goSiteId" value="Enter your Google Site ID" />
            

Direct method(Plan A)

Grabbing Friends Function for Plan A

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

Parameters

Return Type

1. id
2. imageurl
3. name
4. screenname

Sending Invitation Function for Plan A

sendInvitation(<servicename>, <your email>, <your password>, FriendsId, Subject, Message);

Parameters

Return Type

OAuth method(Plan D)

To start grabbing friends using OAuth Method, you have to make request to three functions(this applies for Twitter and LinkedIn)

1. getAuthenticationUrl
2. getAccessToken
3. grabfriends

To configure API keys, click here How to configure API keys.

Function for getAuthenticationUrl function

getAuthenticationUrl(servicename, ConsumerKey, ConsumerSecret, callbackurl);

Parameters

Return type

1. authurl
2. token
3. tokenSecret
4. tokenVerifier

Function for getAccessToken function

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

Parameters

Return type

1. authurl
2. token
3. tokenSecret
4. tokenVerifier

Function for grabfriends function

grabfriends(servicename, token, tokensecret, tokenverifier, ConsumerKey, ConsumerSecret, this.context, IMFile path);

Parameters

Return Types

1. id
2. imageurl
3. name
4. screenname

Debugging

Debugging Twitter:

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 LinkedIn:

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

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 friends inviter 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 "grabFriends"(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 "grabFriends" 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 "grabFriends" 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.