Class ClarifySession

Inheritance

System.Object

FCSession

ClarifySession

Implements

System.IDisposable

Inherited Members

FCSession.InitializeSession(FCSessionData)

FCSession.ResetSessionLoginStatus()

FCSession.LoginFromApp()

FCSession.LoginInternal(String, String, Int32, Boolean, Boolean, Boolean)

FCSession.LoadSessionDataFromApplicationCache(Guid)

FCSession._GetNextDataTableId()

FCSession.RegisterLicenseRequirements(Int32)

FCSession.CloseSession()

FCSession.CloseSession(Boolean)

FCSession.Dispose()

FCSession.SaveSession()

FCSession.GetCurrentServerDate()

FCSession.FormatElapsedTime(Int32)

FCSession.FormatElapsedTime(Double)

FCSession.FormatElapsedTime(TimeSpan)

FCSession.SetPassword(String, String, Int32)

FCSession.ChangePassword(String)

FCSession.ChangeRestrictionGroup(String, Boolean)

FCSession.ConvertDate(DateTime, String, String)

FCSession.ConvertDate(DateTime, ITimeZone, ITimeZone)

FCSession.ConvertFromLocalToServerDate(DateTime)

FCSession.ConvertFromServerToLocalDate(DateTime)

FCSession.GetCurrentDate()

FCSession.RefreshContext()

FCSession.HasPermission(String)

FCSession.GetAssignedPermissions()

FCSession.ShouldConvertToLocalDate(DateTime, DataColumn)

FCSession.SessionData

FCSession.CreationTime

FCSession.LastLoadTime

FCSession.SessionID

FCSession.UserID

FCSession.DefaultCulture

FCSession.CurrentCulture

FCSession.UserName

FCSession.RestrictionGroup

FCSession.Log

FCSession.LocalTimeZone

FCSession.DisableDataConversions

FCSession.IncludeRelations

FCSession.QueryEmptyToNull

FCSession.PasswordRequired

FCSession.DataRestrictionsEnabled

FCSession.DefaultDistinctGenerics

FCSession.MaximumRows

FCSession.TruncateStringFields

FCSession.SetNullStringsToEmpty

FCSession.ConvertTimeZone

FCSession.TimeZoneConversions

FCSession.Items

FCSession.Item[String]

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: FChoice.Foundation.Clarify

Assembly: fcSDK.dll

Syntax

public class ClarifySession : FCSession, IDisposable

Constructors

ClarifySession()

Declaration

protected ClarifySession()

ClarifySession(Guid)

Declaration

protected ClarifySession(Guid sessionId)

Parameters

Type	Name	Description
System.Guid	sessionId

Properties

ConfigItems

Declaration

public ClarifyConfigItemCollection ConfigItems { get; }

Property Value

Type	Description
ClarifyConfigItemCollection

LoginType

Declaration

public ClarifyLoginType LoginType { get; }

Property Value

Type	Description
ClarifyLoginType

Methods

AuthenticateContact(String, String)

Declaration

public static bool AuthenticateContact(string username, string password)

Parameters

Type	Name	Description
System.String	username
System.String	password

Returns

Type	Description
System.Boolean

ChangeUserConfigItem(String, Double)

Declaration

public void ChangeUserConfigItem(string configItemName, double newValue)

Parameters

Type	Name	Description
System.String	configItemName
System.Double	newValue

ChangeUserConfigItem(String, Int32)

Declaration

public void ChangeUserConfigItem(string configItemName, int newValue)

Parameters

Type	Name	Description
System.String	configItemName
System.Int32	newValue

ChangeUserConfigItem(String, String)

Declaration

public void ChangeUserConfigItem(string configItemName, string newValue)

Parameters

Type	Name	Description
System.String	configItemName
System.String	newValue

FormatNumScheme(String, Int32, Boolean, Int32)

Declaration

protected string FormatNumScheme(string schemeFormat, int nextVal, bool padded, int valWidth)

Parameters

Type	Name	Description
System.String	schemeFormat
System.Int32	nextVal
System.Boolean	padded
System.Int32	valWidth

Returns

Type	Description
System.String

GetNextNumScheme(String)

Declaration

public string GetNextNumScheme(string schemeName)

Parameters

Type	Name	Description
System.String	schemeName

Returns

Type	Description
System.String

GetNextNumScheme(String, IDbTransaction)

Declaration

public string GetNextNumScheme(string schemeName, IDbTransaction trans)

Parameters

Type	Name	Description
System.String	schemeName
System.Data.IDbTransaction	trans

Returns

Type	Description
System.String

GetRestrictionGroupForUser(Object)

Declaration

protected override RestrictionGroup GetRestrictionGroupForUser(object userID)

Parameters

Type	Name	Description
System.Object	userID

Returns

Type	Description
RestrictionGroup

Overrides

FCSession.GetRestrictionGroupForUser(Object)

GetUserConfigItem(String, String)

Declaration

protected ClarifyConfigItem GetUserConfigItem(string loginName, string configItemName)

Parameters

Type	Name	Description
System.String	loginName
System.String	configItemName

Returns

Type	Description
ClarifyConfigItem

GetUserConfigItems(String)

Declaration

protected ConfigItemCollection GetUserConfigItems(string loginName)

Parameters

Type	Name	Description
System.String	loginName

Returns

Type	Description
ConfigItemCollection

PerformChangePassword(String, String, Int32)

Declaration

protected override void PerformChangePassword(string username, string newPassword, int loginType)

Parameters

Type	Name	Description
System.String	username
System.String	newPassword
System.Int32	loginType

Overrides

FCSession.PerformChangePassword(String, String, Int32)

PerformChangeResGroup(String, Boolean)

Declaration

protected override RestrictionGroup PerformChangeResGroup(string newGroupName, bool saveChanges)

Parameters

Type	Name	Description
System.String	newGroupName
System.Boolean	saveChanges

Returns

Type	Description
RestrictionGroup

Overrides

FCSession.PerformChangeResGroup(String, Boolean)

PerformConvertDate(DateTime, ITimeZone, ITimeZone)

Declaration

protected override DateTime PerformConvertDate(DateTime date, ITimeZone fromTZ, ITimeZone toTZ)

Parameters

Type	Name	Description
System.DateTime	date
ITimeZone	fromTZ
ITimeZone	toTZ

Returns

Type	Description
System.DateTime

Overrides

FCSession.PerformConvertDate(DateTime, ITimeZone, ITimeZone)

PerformConvertDate(DateTime, String, String)

Declaration

protected override DateTime PerformConvertDate(DateTime date, string fromTZName, string toTZName)

Parameters

Type	Name	Description
System.DateTime	date
System.String	fromTZName
System.String	toTZName

Returns

Type	Description
System.DateTime

Overrides

FCSession.PerformConvertDate(DateTime, String, String)

PerformLogin(String, Int32)

Declaration

protected override object PerformLogin(string inUsername, int inLoginType)

Parameters

Type	Name	Description
System.String	inUsername
System.Int32	inLoginType

Returns

Type	Description
System.Object

Overrides

FCSession.PerformLogin(String, Int32)

PerformLogin(String, String)

Declaration

protected override object PerformLogin(string inUsername, string password)

Parameters

Type	Name	Description
System.String	inUsername
System.String	password

Returns

Type	Description
System.Object

Overrides

FCSession.PerformLogin(String, String)

PerformLogin(String, String, Int32)

Declaration

protected override object PerformLogin(string inUsername, string password, int inLoginType)

Parameters

Type	Name	Description
System.String	inUsername
System.String	password
System.Int32	inLoginType

Returns

Type	Description
System.Object

Overrides

FCSession.PerformLogin(String, String, Int32)

PerformRefreshContext()

Declaration

protected override void PerformRefreshContext()

Overrides

FCSession.PerformRefreshContext()

PerformSetPassword(String, String, Int32)

Declaration

protected override void PerformSetPassword(string username, string newPassword, int loginType)

Parameters

Type	Name	Description
System.String	username
System.String	newPassword
System.Int32	loginType

Overrides

FCSession.PerformSetPassword(String, String, Int32)

SetContactUserPassword(String, String)

Declaration

public static void SetContactUserPassword(string username, string newPassword)

Parameters

Type	Name	Description
System.String	username
System.String	newPassword

SetupSessionData(FCSessionData)

Declaration

protected override void SetupSessionData(FCSessionData data)

Parameters

Type	Name	Description
FCSessionData	data

Overrides

FCSession.SetupSessionData(FCSessionData)

UpdateLastLogin(String)

Declaration

protected override void UpdateLastLogin(string username)

Parameters

Type	Name	Description
System.String	username

Overrides

FCSession.UpdateLastLogin(String)

Explicit Interface Implementations

IDisposable.Dispose()

Declaration

void IDisposable.Dispose()

Implements

System.IDisposable