Object
   |
   +--Klip
         |
         +--Engines
               |
               +--Engines.SalesforceLogin

This object is an advanced feature that is only available in the licensed, commercial version of Klipfolio Dashboard. Contact Klipfolio for further details.

The Engines.SalesforceLogin object provides convenient methods for setting up a login UI for a Salesforce Klip, as shown below. It takes advantage of the functionality provided by Klipfolio Dashboard's Salesforce Login extension, and may be used with the Engines.Salesforce object. It is especially useful when there are multiple Salesforce Klips, as the Login extension includes a data pool in which login and logout information is stored and shared.

Since:
5.2.1

Also see:
Force.com Web Services API Developer's Guide for requirements, limitations and restrictions of the Salesforce API, especially the Security and the API section.

---

 

Function Summary
String	getAccountType()            Gets the account type (Enterprise or Partner) that was selected during log in.
String	getPassword()            Gets the password associated with the username under which the user is currently logged in.
String	getRemember()            Checks whether the user opted to have the username and password remembered on the computer during login.
String	getUsername()            Gets the username under which the user is currently logged in.
String	getWebSessionId()            Gets the sessionID.
function	launchLoginUI()            Opens the Salesforce Login extension's login window.
function	requestLogout()            Sends a logout request to Klipfolio Dashboard's Salesforce Login extension, which will log the user out of all Salesforce Klips that are using it.
function	requestRelogin()            Tells Klipfolio Dashboard's Salesforce Login extension to send another login request when the login fails after the user has provided a valid username and password.

Function Detail

getAccountType

String getAccountType()

Gets the account type (Enterprise or Partner) that was selected during log in.



Since:
5.2.1

Returns:
c for Enterprise; u for Partner

---

getPassword

String getPassword()

Gets the password associated with the username under which the user is currently logged in.

Since:
5.2.1

Returns:
the password

---

getRemember

String getRemember()

Checks whether the user opted to have the username and password remembered on the computer during login.

If the login information is remembered, Klipfolio Dashboard will automatically make an attempt to log in to Salesforce.com whenever it starts up.

Note that, regardless of the Remember setting, the login process and the way failed attempts are handled by the engine described above apply.



Since:
5.2.1

Returns:
true if the "Remember me..." checkbox was selected; otherwise false

---

getUsername

String getUsername()

Gets the username under which the user is currently logged in.

Since:
5.2.1

Returns:
the username

---

getWebSessionId

String getWebSessionId()

Gets the sessionID. This can be used to build a link that prevents the user from having to log in in the browser separately.

Since:
5.2.1

Returns:
session ID

---

launchLoginUI

function launchLoginUI()

Opens the Salesforce Login extension's login window.

Since:
5.2.1

---

requestLogout

function requestLogout()

Sends a logout request to Klipfolio Dashboard's Salesforce Login extension, which will log the user out of all Salesforce Klips that are using it.

Since:
5.2.1

---

requestRelogin

function requestRelogin()

Tells Klipfolio Dashboard's Salesforce Login extension to send another login request when the login fails after the user has provided a valid username and password. If this request fails, all Klips will log out.

Since:
5.2.1

---

Overview   Object  Tree  Index  Help			Klipfolio Dashboard API
PREV OBJECT  NEXT OBJECT	FRAMES    NO FRAMES
SUMMARY: PROPERTY | FUNCTION	DETAIL: PROPERTY | FUNCTION

---

© 2011 Klipfolio Inc. All Rights Reserved.