Click or drag to resize

IUserAgent Interface
Represents a user agent branding. This is a branding system used only for XSLT rendering.

User agent branding is used to define cobranding at the client level. Each user agent branding entry corresponds to a presentation style collection. User agent branding at run time is determined by locating its search string on the requested, browser-specific user agent string. If the search string is found on the requested user agent, then this user agent branding is applied.

Creating user agent brandings allows presentation style switching based on browser type. This is mainly used for mobile-device detection.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
Copy
public interface IUserAgent : IBrandEntryBase, 
	IEntity<ISiteMap>, IEntity, IEntityEvents

The IUserAgent type exposes the following members.

Properties
  NameDescription
Public propertyArchived
Gets/sets the archived value of this entity
(Inherited from IEntity.)
Public propertyContentType
Gets and sets the type of content this user agent should present.
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyFileExtension
Getss and sets the file extension this user agent should present.
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertySearchString
Gets and sets the search string of this brand entry.
(Inherited from IBrandEntryBase.)
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Top
Methods
  NameDescription
Public methodTouch
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.)
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Top
Remarks

At run time, the information of applied user agent branding is included in the IGX_Info/XPRESS/USER_AGENT element:

XML
Copy
<IGX_Info>
  <XPRESS>
    <USER_AGENT>mobile</USER_AGENT>
  </XPRESS>
</IGX_Info>

User agent brandings are managed by the ISiteMap manager object.

Examples
User agent brandings are retrieved from ISiteMap:
C#
Copy
IUserAgent siteBrand = session.SiteMap.UserAgent("mobile");
See Also