Click or drag to resize
DeviceProfileInfoProvider Class
Class providing Device profile management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderDeviceProfileInfo, DeviceProfileInfoProvider, ObjectQueryDeviceProfileInfo
    CMS.DataEngineAbstractInfoProviderDeviceProfileInfo, DeviceProfileInfoProvider
      CMS.DeviceProfilesDeviceProfileInfoProvider

Namespace: CMS.DeviceProfiles
Assembly: CMS.DeviceProfiles (in CMS.DeviceProfiles.dll) Version: 12.0.0
Syntax
C#
public class DeviceProfileInfoProvider : AbstractInfoProvider<DeviceProfileInfo, DeviceProfileInfoProvider>

The DeviceProfileInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodDeviceProfileInfoProvider
Constructor
Top
Fields
  NameDescription
Public fieldStatic memberDEVICE_IMAGE_CACHE_KEY
Name of cache key for automatic image resizing for device profiles.
Public fieldStatic memberDEVICENAME_QUERY_PARAM
Query parameter name for loading device profile from query.
Public fieldStatic memberDEVICES_QUERY_PARAM
Query parameter name for loading device profile from cookies.
Protected fieldinfos
Info tables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Properties
  NameDescription
Public propertyStatic memberCurrentDeviceProfileName
Current device profile name stored in cookie
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clear hashtables.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryClearHashtables(Boolean).)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteDeviceProfileInfo(Int32)
Deletes device info with specified ID.
Public methodStatic memberDeleteDeviceProfileInfo(DeviceProfileInfo)
Deletes specified device info.
Protected methodDeleteDeviceProfileInfoInternal
Deletes specified device info.
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetCurrentDeviceProfileInfo(String)
Returns current device profile info.
Public methodStatic memberGetCurrentDeviceProfileInfo(String, Boolean)
Returns current device profile info.
Protected methodGetCurrentDeviceProfileInfoInternal
Returns current device profile info.
Protected methodGetCurrentDeviceProfilesInternal
Returns current device profile info based on current user agent. The value based on the user agent can be overwritten by query string parameter or by cookie (CMSCurrentDeviceInfo).
Public methodStatic memberGetCurrentDevicProfiles
Returns ordered list of device profiles matching current device (can be overridden by URL parameter or cookie).
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetDeviceProfileInfo(Int32)
Returns device info with specified ID.
Public methodStatic memberGetDeviceProfileInfo(String)
Returns device info with specified name.
Public methodStatic memberGetDeviceProfileInfo(Guid, String)
Returns device info with specified GUID.
Public methodStatic memberGetDeviceProfiles
Returns all device profiles.
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetLastProfileOrder
Returns order of the last profile.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetOriginalCurrentDevicProfileName
Returns current original device profile name (cannot be overridden by URL parameter or cookie).
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberInitProfilesOrder
Initialize profiles order.
Protected methodInitProfilesOrderInternal
Initializes sorting order of profiles.
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberIsDeviceProfilesEnabled
Returns true if device profiles are enabled for given site.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadFromCookies
Returns true if device info should be loaded from cookies.
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberMoveProfileDown
Moves profile down.
Protected methodMoveProfileDownInternal
Moves profile up.
Public methodStatic memberMoveProfileUp
Moves profile up.
Protected methodMoveProfileUpInternal
Moves profile up.
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryProcessWebFarmTask(String, String, Byte).)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetCurrentDeviceProfileInfo
Sets current device profile info.
Protected methodSetCurrentDeviceProfileInfoInternal
Sets current device profile info.
Public methodStatic memberSetDeviceProfileInfo
Sets (updates or inserts) specified device info.
Protected methodSetDeviceProfileInfoInternal
Sets (updates or inserts) specified device info.
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also