fcSDK Documentation
ClarifySession Class Members
Properties  Methods 

The following tables list the members exposed by ClarifySession.

Public Properties
 NameDescription
Public PropertyConfigItems  
Public PropertyConvertTimeZoneSets whether or not any DateTimes will be translated to and from ServerTimeZone and LocalTimeZone. Default value is false. (Inherited from FChoice.Foundation.FCSession)
Public PropertyCreationTimeTimestamp when the session was created. (Inherited from FChoice.Foundation.FCSession)
Public PropertyCurrentCultureReturns the Culture being used by the session. (Inherited from FChoice.Foundation.FCSession)
Public PropertyDataRestrictionsEnabled (Inherited from FChoice.Foundation.FCSession)
Public PropertyDefaultCultureReturns the default Culture being used by the session. (Inherited from FChoice.Foundation.FCSession)
Public PropertyDefaultDistinctGenerics

Sets whether or not newly created generic objects will have IsDistinct set to include all relation data fields during Queries.

(Inherited from FChoice.Foundation.FCSession)
Public PropertyDisableDataConversionsSets whether data conversions happen when GenericDataRow fields are modified. (Inherited from FChoice.Foundation.FCSession)
Public PropertyIncludeRelationsSets whether or not newly created generic objects will include all relation data fields during Queries. (Inherited from FChoice.Foundation.FCSession)
Public PropertyItemGet or set session data indexed by specified key. (Inherited from FChoice.Foundation.FCSession)
Public PropertyItems (Inherited from FChoice.Foundation.FCSession)
Public PropertyLastLoadTimeTimestamp when the session was last loaded via FCApplication.GetSession (Inherited from FChoice.Foundation.FCSession)
Public PropertyLocalTimeZoneThe TimeZone being used by the session. (Inherited from FChoice.Foundation.FCSession)
Public PropertyLogReturns a Logger useful for logging application events or errors to the logging system. (Inherited from FChoice.Foundation.FCSession)
Public PropertyLoginType  
Public PropertyMaximumRows (Inherited from FChoice.Foundation.FCSession)
Public PropertyPasswordRequiredGets whether or not a password was used when CreateSession was called. (Inherited from FChoice.Foundation.FCSession)
Public PropertyQueryEmptyToNull

Sets whether or not new newly created generic objects  convert filters on empty strings into filters on Queries that check Is NULL or IS NOT NULL.

(Inherited from FChoice.Foundation.FCSession)
Public PropertyRestrictionGroupReturns the data restriction group being used by the session. (Inherited from FChoice.Foundation.FCSession)
Public PropertySessionData (Inherited from FChoice.Foundation.FCSession)
Public PropertySessionID

Returns the session's unique identifier.

(Inherited from FChoice.Foundation.FCSession)
Public PropertySetNullStringsToEmptySets whether or not newly created generic objects will convert a null reference (Nothing in Visual Basic) to empty strings. (Inherited from FChoice.Foundation.FCSession)
Public PropertyTruncateStringFieldsSets whether or not newly created generic objects will truncate string fields if they are too long. (Inherited from FChoice.Foundation.FCSession)
Public PropertyUserIDReturns the unique identifier for the session's logged-in user. (Inherited from FChoice.Foundation.FCSession)
Public PropertyUserNameReturns the login name for the session's logged-in user. (Inherited from FChoice.Foundation.FCSession)
Top
Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)AuthenticateContact  
Public MethodChangePasswordChange the password for the session user. (Inherited from FChoice.Foundation.FCSession)
Public MethodChangeRestrictionGroupChanges the RestrictionGroup the session is currently using. The change can be made permanent. (Inherited from FChoice.Foundation.FCSession)
Public MethodChangeUserConfigItemOverloaded.   
Public MethodCloseSessionRemove the session from FCApplication and any Licenses it may be holding. (Inherited from FChoice.Foundation.FCSession)
Public MethodConvertDateOverloaded. Converts a DateTime from one TimeZone to another. (Inherited from FChoice.Foundation.FCSession)
Public MethodConvertFromLocalToServerDateConverts a DateTime from the session timezone to the server timezone. (Inherited from FChoice.Foundation.FCSession)
Public MethodConvertFromServerToLocalDate

Converts a DateTime from the server timezone to the session timezone.

(Inherited from FChoice.Foundation.FCSession)
Public MethodDispose (Inherited from FChoice.Foundation.FCSession)
Public MethodFormatElapsedTimeOverloaded. Formats an numeric value in seconds into a string "DDD HH MMM" where: D=Days, H=Hours, M=Minutes (Inherited from FChoice.Foundation.FCSession)
Public MethodGetAssignedPermissions (Inherited from FChoice.Foundation.FCSession)
Public MethodGetCurrentDateRetrieves the DateTime of the CRM database. (Inherited from FChoice.Foundation.FCSession)
Public MethodGetCurrentServerDateRetrieves the DateTime of the CRM database. (Inherited from FChoice.Foundation.FCSession)
Public MethodGetNextNumSchemeOverloaded.   
Public MethodHasPermission (Inherited from FChoice.Foundation.FCSession)
Public MethodRefreshContextRefresh the session information for the logged-in user. (Inherited from FChoice.Foundation.FCSession)
Public MethodRegisterLicenseRequirements (Inherited from FChoice.Foundation.FCSession)
Public MethodSaveSession (Inherited from FChoice.Foundation.FCSession)
Public Methodstatic (Shared in Visual Basic)SetContactUserPassword  
Public MethodSetPasswordChange a user's password (Inherited from FChoice.Foundation.FCSession)
Top
See Also

Reference

ClarifySession Class
FChoice.Foundation.Clarify Namespace

 

 


© 2010 Dovetail Software, Inc. - All rights reserved.
- Clarify, Amdocs, and related products and names are copyright and trademark of Amdocs, Inc.
- .NET, Visual Studio.NET, C#, Visual Basic and related products are trademark of Microsoft corporation.

Send comments on this topic.