Interface IPortalAliasService

Portal Alias APIs for managing the different Portal Alias.

Namespace: DotNetNuke.Abstractions.Portals
Assembly: DotNetNuke.Abstractions.dll
Syntax
public interface IPortalAliasService

Methods

| Improve this Doc View Source

AddPortalAlias(IPortalAliasInfo)

Adds a new Portal Alias.

Declaration
int AddPortalAlias(IPortalAliasInfo portalAlias)
Parameters
Type Name Description
IPortalAliasInfo portalAlias

The portal alias.
Returns
Type Description
System.Int32

The new portal alias ID.
| Improve this Doc View Source

DeletePortalAlias(IPortalAliasInfo)

Deletes an existing portal alias.

Declaration
void DeletePortalAlias(IPortalAliasInfo portalAlias)
Parameters
Type Name Description
IPortalAliasInfo portalAlias

The portal alias to delete.
| Improve this Doc View Source

GetPortalAlias(String, Int32)

Gets the portal alias.

Declaration
IPortalAliasInfo GetPortalAlias(string alias, int portalId)
Parameters
Type Name Description
System.String alias

The portal alias.
System.Int32 portalId

The portal ID.
Returns
Type Description
IPortalAliasInfo

Portal Alias Info.
| Improve this Doc View Source

GetPortalAlias(String)

Get a portal alias by name.

Declaration
IPortalAliasInfo GetPortalAlias(string alias)
Parameters
Type Name Description
System.String alias

The name of the portal alias.
Returns
Type Description
IPortalAliasInfo

The portal alias.
| Improve this Doc View Source

GetPortalAliasByPortal(Int32, String)

Gets the portal alias by portal.

Declaration
string GetPortalAliasByPortal(int portalId, string portalAlias)
Parameters
Type Name Description
System.Int32 portalId

The portal id.
System.String portalAlias

The portal alias.
Returns
Type Description
System.String

Portal alias.
| Improve this Doc View Source

GetPortalAliasByPortalAliasId(Int32)

Gets the portal alias by portal alias ID.

Declaration
IPortalAliasInfo GetPortalAliasByPortalAliasId(int portalAliasId)
Parameters
Type Name Description
System.Int32 portalAliasId

The portal alias ID.
Returns
Type Description
IPortalAliasInfo

Portal alias info.
| Improve this Doc View Source

GetPortalAliasByTab(Int32, String)

Gets the portal alias by tab.

Declaration
string GetPortalAliasByTab(int tabId, string portalAlias)
Parameters
Type Name Description
System.Int32 tabId

The tab ID.
System.String portalAlias

The portal alias.
Returns
Type Description
System.String

Portal alias.
| Improve this Doc View Source

GetPortalAliases()

Get all portal aliases.

Declaration
IDictionary<string, IPortalAliasInfo> GetPortalAliases()
Returns
Type Description
IDictionary<System.String, IPortalAliasInfo>

A collection of portal aliases.
| Improve this Doc View Source

GetPortalAliasesByPortalId(Int32)

Get all the portal aliases for a specific portal.

Declaration
IEnumerable<IPortalAliasInfo> GetPortalAliasesByPortalId(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
Returns
Type Description
IEnumerable<IPortalAliasInfo>

An IEnumerable of portal aliases.
| Improve this Doc View Source

GetPortalByPortalAliasId(Int32)

Gets the portal by portal alias ID.

Declaration
IPortalInfo GetPortalByPortalAliasId(int portalAliasId)
Parameters
Type Name Description
System.Int32 portalAliasId

The portal alias id.
Returns
Type Description
IPortalInfo

Portal info.
| Improve this Doc View Source

UpdatePortalAlias(IPortalAliasInfo)

Update a specified portal alias.

Declaration
void UpdatePortalAlias(IPortalAliasInfo portalAlias)
Parameters
Type Name Description
IPortalAliasInfo portalAlias

The portal alias to update.
| Improve this Doc View Source

ValidateAlias(String, Boolean)

Validates the alias.

Declaration
bool ValidateAlias(string portalAlias, bool ischild)
Parameters
Type Name Description
System.String portalAlias

The portal alias.
System.Boolean ischild

if set to true, validate the alias as a child alias (i.e. as a subdirectory of another alias).
Returns
Type Description
System.Boolean

true if the alias is a valid url format; otherwise return false.

Extension Methods