fcSDK Documentation
FCSession Class Members
Properties  Methods 

The following tables list the members exposed by FCSession.

Public Properties
 NameDescription
Public PropertyConfigItemsCollection of CRM session configuration items.  
Public PropertyConvertTimeZoneSets whether or not any DateTimes will be translated to and from ServerTimeZone and LocalTimeZone. Default value is false.  
Public PropertyCreationTimeTimestamp when the session was created.  
Public PropertyCurrentCultureReturns the Culture being used by the session.  
Public PropertyDataRestrictionsEnabled  
Public PropertyDefaultCultureReturns the default Culture being used by the session.  
Public PropertyDefaultDistinctGenerics

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

 
Public PropertyDisableDataConversionsSets whether data conversions happen when GenericDataRow fields are modified.  
Public PropertyIncludeRelationsSets whether or not newly created generic objects will include all relation data fields during Queries.  
Public PropertyItemGet or set session data indexed by specified key.  
Public PropertyItems  
Public PropertyLastLoadTimeTimestamp when the session was last loaded via FCApplication.GetSession  
Public PropertyLocalTimeZoneThe TimeZone being used by the session.  
Public PropertyLogReturns a Logger useful for logging application events or errors to the logging system.  
Public PropertyLoginTypeReturns the login type of the logged-in user.  
Public PropertyMaximumRows  
Public PropertyPasswordRequiredGets whether or not a password was used when CreateSession was called.  
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.

 
Public PropertyRestrictionGroupReturns the data restriction group being used by the session.  
Public PropertySessionData  
Public PropertySessionID

Returns the session's unique identifier.

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

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

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

Reference

FCSession Class
FChoice.Foundation 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.