IDeviceBundle Interface Ingeniux CMS Content Store API

Represents a collection of device-browser combinations that share a manufacturer and screen size. DeviceBundles are for mobile emulation in page preview only. It has a representative Device that provides a single user agent string for the emulation. If a page previews correctly with selected bundle, it means the page will display properly on all the devices this bundle includes.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax

public interface IDeviceBundle : IDevice, 
	IEntity, IEntityEvents

The IDeviceBundle type exposes the following members.

Properties

  NameDescription
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 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 propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyRepresentativeDevice
Gets the device that represents this bundle. This device's user agent is used for mobile preview emulation.
Public propertyCode exampleScreenHeight
Gets the simulated screen height for browser. All devices in this bundle will have the same height.
Public propertyCode exampleScreenWidth
Gets the simulated screen width for browser. All devices in this bundle have the same width.
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.)
Public propertyUserAgent
Gets the User Agent string in this device/browser combination
(Inherited from IDevice.)
Top
Methods

  NameDescription
Public methodAddDevice
Adds a new device to this bundle.
Public methodClear
Clears all devices from this bundle.
Public methodDevices
Retrieves the collection of devices included in this bundle, in a paginated format.
Public methodDevicesCount
Gets count of all devices in this bundle.
Public methodRemoveDevice
Removes a device from bundle.
Public methodSetRepresentativeDevice
Sets representative device of the bundle.
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
Examples

Serialization of this object matches the DeviceBundle element of in the MobileDevices.xml file in previous-generation CMS content.
<DeviceBundle N="iPhone" W="320" H="480" 
  UA="Mozilla/5.0 (iPhone; CPU iPhone OS 5_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B125 Safari/7534.48.3" RDID="12280-18117-17776-18092">
<D>Mozilla/5.0 (iPhone; CPU iPhone OS 5_1 like Mac OS X) AppleWebKit/534.85 (KHTML, like Gecko) Version/5.1 Mobile/9B125 Safari/7534.48.3</D>
</DeviceBundle>
See Also

Reference