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: 9.0.565.0 (9.0.565)
The IUserAgent type exposes the following members.
| Name | Description | |
|---|---|---|
 | ContentType |
Gets and sets the type of content this user agent should present.
|
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| FileExtension |
Getss and sets the file extension this user agent should present.
|
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity.) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.) |
| Name |
Gets and sets the entity's name.
(Inherited from IEntity.) |
| SearchString |
Gets and sets the search string of this brand entry.
(Inherited from IBrandEntryBase.) |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.) |
| Name | Description | |
|---|---|---|
 | ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity.) |
| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.) |
At run time, the information of applied user agent branding is included in the IGX_Info/XPRESS/USER_AGENT element:
<IGX_Info> <XPRESS> <USER_AGENT>mobile</USER_AGENT> </XPRESS> </IGX_Info>
User agent brandings are managed by the ISiteMap manager object.
IUserAgent siteBrand = session.SiteMap.UserAgent("mobile");