Class LogoutPlugin

A plugin that is executed when the user chooses to log out.

Inheritance
System.Object
Plugin
LogoutPlugin
Inherited Members
Namespace: Softadmin.Api.Logout
Assembly: Softadmin.Api.dll
Syntax
public abstract class LogoutPlugin : Plugin
Remarks

You can use logout plugins to redirect the logged out user to an alternate URL, for example to return to a company's shared service portal or to an OpenID logout endpoint.

Logout plugins are only invoked when the user explicitly chooses to log out. They are not invoked when the user simply closes the browser window or lets the session time out.

Examples
public override void OnLogout()
{
	this.SetRedirectUrl(this.SystemSettings["LogoutUrl"]);
}

Methods

OnLogout()

Invoked when a user chooses to log out.

Declaration
public abstract void OnLogout()

SetRedirectUrl(String)

Sets an alternative URL to redirect the user to after logout. The value may only be set once across all logout plugins.

Declaration
protected void SetRedirectUrl(string url)
Parameters
Type Name Description
System.String url