finPortalHandler Class

Methods

	Name	Description
	ApplicationLock	Lock access to the Application object.
	ApplicationUnlock	Unlock access to the Application object.
	AuthenticateClient	Authenticate a finPOWER Connect Client.
	AuthenticateUser	Authenticate a finPOWER Connect User.
	ChangePassword	Change the User's or Client's Password.
	CreateScriptContextData	Create Script Context Data that can then be passed to the HTML Summary Page String builder to control how the page is produced.
	ExecuteDataAdaptorEvent	Execute an event in the configured Data Adaptor Script ensuring parameters always contains a ClientId or UserId entry if this is a Client or User Portal (and, if these were not supplied, the corresponding Client and User object parameters).
	ExecuteEvent System Use Only	Execute an HTML Widget type script for this Portal or, if specified, a Portal Page.
	GetClientAccount	Returns a finAccount object for one of this Client's Accounts whilst also validating that the Account belongs to this Client for 'Client' Authenticated Portals.
	GetClientAccountFromApplication	Returns finAccount and finAccountApp objects for one of this Client's Applications whilst also validating that the Application belongs to this Client for 'Client' Authenticated Portals.
	GetClientAccountFromApplicationFromExtendedList	Returns finAccount and finAccountApp objects for one of this Client's Applications whilst also validating that the Application belongs to this Client for 'Client' Authenticated Portals.
	GetClientAccountFromExtendedList	Returns a finAccount object for one of this Client's Accounts whilst also validating that the Account belongs to this Client for 'Client' Authenticated Portals.
	GetCustomLoginPageId	Get the Page Id of a Custom Login Page.
	GetCustomPasswordChangePageId	Get the Page Id of a Custom Password Change Page.
	GetCustomPasswordResetPageId	Get the Page Id of a Custom Password Reset Page.
	GetMultiFactorAuthenticationMethodResolved	Get the Multi-Factor Authentication Method (MFA) to use.
	GetPageHtml	Get a Portal Page HTML from a URL, e.g., "" or "/" will return the default page or "/Test?param1=a" will get the "Test" page and also pass in parameters.
	GetPage_401 System Use Only	Get HTML for a 401 (Not Authorised) page.
	GetPage_503 System Use Only	Get HTML for a 503 (Service Unavailable) page.
	GetPortalUrlWebServices	Get the URL of this Portal when running from Web Services.
	GetResourceDataUri	Get a Data URI to a Resource, e.g., an Image.
	GetResourceText	Get the Text of a Resource, e.g., a Text, HTML, CSS or JavaScript type Resource.
	GetResourceUrl	Get a URL to a Resource, e.g., an Image.
	Initialise	Initialise Portal Handler.
	IsFileUploadValid	Check to see if a File being Uploaded is Valid based on this Portal's File Upload restrictions.
	PerformBLCurrentUserQuickLoginFromToken System Use Only	Perform a CurrentUserQuickLogin using the current Token for a User-based portal.
	ReauthenticateToken	Re-authenticate a currently signed in User, Client or Anonymous Session.
	Refresh	Refresh this Portal Handler, e.g., before doing anything in a multi-use environment such as Web Services including calling the ReauthenticateToken method.
	ResetPasswordFromToken	Reset a User's or Client's Password from a Token.
	ResolveLess	Resolve LESS-based CSS.
	SendPasswordResetLink	Send a Password Reset Link to the User or Client.
	SystemGetString System Use Only
	ValidateAccountAppLogPk	Ensures that a specified Account Application Log Pk belongs to one of the Account Applications for the authenticated Client.
	ValidateAccountLogPk	Ensures that a specified Account Log Pk belongs to one of the Accounts for the authenticated Client.
	ValidateClientLogPk	Ensures that a specified Client Log Pk belongs to the authenticated Client.

Properties

	Name	Description
	Application Read-Only	The Application state object. Use ApplicationLock and ApplicationUnlock either side of accessing this object if making changes to it.
	AuthenticatedClientId Read-Only	The Id of the currently Authenticated Client.
	AuthenticatedClientWebUserId Read-Only	The Web User Id of the currently Authenticated Client.
	AuthenticatedUserId Read-Only	The Id of the currently Authenticated User.
	AuthenticatedUserType Read-Only
	HostingContext Read-Only	This Portal's Hosting Context.
	IsInitialised Read-Only	Indicates whether this Portal Handler has been Initialised.
	MustChangePassword Read-Only	Indicates whether a User or Client must change their password.
	Portal Read-Only System Use Only
	PortalUserData Read-Only	The User Data stored against the Portal.
	SendDebugInformation Read-Only	Indicates whether send 'Debug-NNN' HTTP Headers with the HTTP Response.
	Session Read-Only	The Session state object.
	SessionId Read-Only	The Session Id.
	UserData Read-Only	The User Data state object or Nothing for Unauthenticated Portals.
	WebRequestPortalRoot System Use Only	Used internally by Web Services to store the root to the Portal, e.g., for Resource tag resolution.

Fields

	Name	Description
	DEFAULT_PASSWORDRESETSENTMESSAGE Read-Only

Namespace:

Intersoft.finSupport6

Assembly:

finSupport6, Version=6.0.3

Target Framework:

.NET 9.0