ClarifySession Class Members

The following tables list the members exposed by ClarifySession.

Public Properties

|   | Name | Description | | --- | --- | --- | | Public Property | ConfigItems |   | | Public Property | ConvertTimeZone | Sets whether or not any DateTimes will be translated to and from ServerTimeZone and LocalTimeZone. Default value is false. (Inherited from FChoice.Foundation.FCSession) | | Public Property | CreationTime | Timestamp when the session was created. (Inherited from FChoice.Foundation.FCSession) | | Public Property | CurrentCulture | Returns the Culture being used by the session. (Inherited from FChoice.Foundation.FCSession) | | Public Property | DataRestrictionsEnabled | (Inherited from FChoice.Foundation.FCSession) | | Public Property | DefaultCulture | Returns the default Culture being used by the session. (Inherited from FChoice.Foundation.FCSession) | | Public Property | DefaultDistinctGenerics | 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 Property | DisableDataConversions | Sets whether data conversions happen when GenericDataRow fields are modified. (Inherited from FChoice.Foundation.FCSession) | | Public Property | IncludeRelations | Sets whether or not newly created generic objects will include all relation data fields during Queries. (Inherited from FChoice.Foundation.FCSession) | | Public Property | Item | Get or set session data indexed by specified key. (Inherited from FChoice.Foundation.FCSession) | | Public Property | Items | (Inherited from FChoice.Foundation.FCSession) | | Public Property | LastLoadTime | Timestamp when the session was last loaded via FCApplication.GetSession (Inherited from FChoice.Foundation.FCSession) | | Public Property | LocalTimeZone | The TimeZone being used by the session. (Inherited from FChoice.Foundation.FCSession) | | Public Property | Log | Returns a Logger useful for logging application events or errors to the logging system. (Inherited from FChoice.Foundation.FCSession) | | Public Property | LoginType |   | | Public Property | MaximumRows | (Inherited from FChoice.Foundation.FCSession) | | Public Property | PasswordRequired | Gets whether or not a password was used when CreateSession was called. (Inherited from FChoice.Foundation.FCSession) | | Public Property | QueryEmptyToNull |

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 Property | RestrictionGroup | Returns the data restriction group being used by the session. (Inherited from FChoice.Foundation.FCSession) | | Public Property | SessionData | (Inherited from FChoice.Foundation.FCSession) | | Public Property | SessionID |

Returns the session's unique identifier.

(Inherited from FChoice.Foundation.FCSession) | | Public Property | SetNullStringsToEmpty | Sets 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 Property | TruncateStringFields | Sets whether or not newly created generic objects will truncate string fields if they are too long. (Inherited from FChoice.Foundation.FCSession) | | Public Property | UserID | Returns the unique identifier for the session's logged-in user. (Inherited from FChoice.Foundation.FCSession) | | Public Property | UserName | Returns the login name for the session's logged-in user. (Inherited from FChoice.Foundation.FCSession) |

Public Methods

|   | Name | Description | | --- | --- | --- | | Public Methodstatic (Shared in Visual Basic) | AuthenticateContact |   | | Public Method | ChangePassword | Change the password for the session user. (Inherited from FChoice.Foundation.FCSession) | | Public Method | ChangeRestrictionGroup | Changes the RestrictionGroup the session is currently using. The change can be made permanent. (Inherited from FChoice.Foundation.FCSession) | | Public Method | ChangeUserConfigItem | Overloaded.    | | Public Method | CloseSession | Remove the session from FCApplication and any Licenses it may be holding. (Inherited from FChoice.Foundation.FCSession) | | Public Method | ConvertDate | Overloaded. Converts a DateTime from one TimeZone to another. (Inherited from FChoice.Foundation.FCSession) | | Public Method | ConvertFromLocalToServerDate | Converts a DateTime from the session timezone to the server timezone. (Inherited from FChoice.Foundation.FCSession) | | Public Method | ConvertFromServerToLocalDate | Converts a DateTime from the server timezone to the session timezone.

(Inherited from FChoice.Foundation.FCSession) | | Public Method | Dispose | (Inherited from FChoice.Foundation.FCSession) | | Public Method | FormatElapsedTime | Overloaded. 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 Method | GetAssignedPermissions | (Inherited from FChoice.Foundation.FCSession) | | Public Method | GetCurrentDate | Retrieves the DateTime of the CRM database. (Inherited from FChoice.Foundation.FCSession) | | Public Method | GetCurrentServerDate | Retrieves the DateTime of the CRM database. (Inherited from FChoice.Foundation.FCSession) | | Public Method | GetNextNumScheme | Overloaded.    | | Public Method | HasPermission | (Inherited from FChoice.Foundation.FCSession) | | Public Method | RefreshContext | Refresh the session information for the logged-in user. (Inherited from FChoice.Foundation.FCSession) | | Public Method | RegisterLicenseRequirements | (Inherited from FChoice.Foundation.FCSession) | | Public Method | SaveSession | (Inherited from FChoice.Foundation.FCSession) | | Public Methodstatic (Shared in Visual Basic) | SetContactUserPassword |   | | Public Method | SetPassword | Change a user's password (Inherited from FChoice.Foundation.FCSession) |

Reference

ClarifySession Class
FChoice.Foundation.Clarify Namespace