CMS.DeviceProfiles.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>CMS.DeviceProfiles</name> </assembly> <members> <member name="T:CMS.DeviceProfiles.CurrentDevice"> <summary> Class holding the current device information. </summary> </member> <member name="P:CMS.DeviceProfiles.CurrentDevice.Data"> <summary> Data container of all available device properties. Use the property names available in the <see cref="T:System.Web.HttpBrowserCapabilities"/> class as a key to obtain the desired device information. </summary> </member> <member name="T:CMS.DeviceProfiles.HttpBrowserCapabilitiesAdapter"> <summary> Converts the <see cref="T:System.Web.HttpBrowserCapabilities" /> class to fulfill <see cref="T:CMS.Base.ISimpleDataContainer" /> interface. </summary> </member> <member name="P:CMS.DeviceProfiles.HttpBrowserCapabilitiesAdapter.CMS#Base#ISimpleDataContainer#Item(System.String)"> <summary> Gets specific browser capability. </summary> <param name="columnName">Browser capability name.</param> </member> <member name="M:CMS.DeviceProfiles.HttpBrowserCapabilitiesAdapter.GetValue(System.String)"> <summary> Gets specific browser capability. </summary> <param name="columnName">Browser capability name.</param> </member> <member name="M:CMS.DeviceProfiles.HttpBrowserCapabilitiesAdapter.SetValue(System.String,System.Object)"> <summary> Not implemented. </summary> <param name="columnName">Not implemented.</param> <param name="value">Not implemented.</param> </member> <member name="T:CMS.DeviceProfiles.CurrentDeviceExtensions"> <summary> Provides extension methods for <see cref="T:CMS.DeviceProfiles.CurrentDevice" />. </summary> </member> <member name="M:CMS.DeviceProfiles.CurrentDeviceExtensions.IsMobile(CMS.DeviceProfiles.CurrentDevice)"> <summary> Extends <see cref="T:CMS.DeviceProfiles.CurrentDevice"/> for detection if <paramref name="device" /> is mobile. </summary> <param name="device">Device to extend.</param> <remarks> Uses the default .NET Framework mobile device recognition. </remarks> <returns>Returns true when <paramref name="device" /> is a mobile device.</returns> <exception cref="T:System.ArgumentNullException"><paramref name="device"/> or is null.</exception> </member> <member name="T:CMS.DeviceProfiles.DeviceContext"> <summary> Context data for device profiles </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceContext.CurrentDevice"> <summary> Returns current device information. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceContext.DevicesAvailable"> <summary> Returns true if device profile are available in current domain license. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceContext.CurrentDeviceProfile"> <summary> Returns current device profile info. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceContext.CurrentDeviceProfiles"> <summary> Returns list of current device profiles. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceContext.CurrentDeviceProfileName"> <summary> Returns current device profile name. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceContext.OriginalCurrentDeviceProfileName"> <summary> Gets or sets the current device profile name </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceContext.GetDeviceProfilesClass"> <summary> Gets all device profiles specific CSS class name. </summary> </member> <member name="T:CMS.DeviceProfiles.IThemeInfo"> <summary> Interface for the themeable info objects </summary> </member> <member name="P:CMS.DeviceProfiles.IThemeInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="M:CMS.DeviceProfiles.IThemeInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="T:CMS.DeviceProfiles.DeviceProfilesModule"> <summary> Represents the Device profiles module. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfilesModule.#ctor"> <summary> Default constructor </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfilesModule.OnInit"> <summary> Init module </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfilesModule.InitImportExport"> <summary> Initializes import/export handlers </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfilesModule.InitMacros"> <summary> Initializes the device profiles macros </summary> </member> <member name="T:CMS.DeviceProfiles.DeviceProfilesModuleMetadata"> <summary> Represents the Device profiles module metadata. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfilesModuleMetadata.#ctor"> <summary> Default constructor </summary> </member> <member name="T:CMS.DeviceProfiles.DeviceProfilesResolvers"> <summary> Resolvers used in e-mail templates and other macro visual components. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfilesResolvers.DeviceProfilesResolver"> <summary> Returns device profiles macro resolver. </summary> </member> <member name="T:CMS.DeviceProfiles.DeviceProfileImport"> <summary> Handles special actions during the device profile import process. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileImport.Init"> <summary> Initializes import handlers </summary> </member> <member name="T:CMS.DeviceProfiles.DeviceProfileInfo"> <summary> DeviceProfile data container class. </summary> </member> <member name="F:CMS.DeviceProfiles.DeviceProfileInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.DeviceProfiles.DeviceProfileInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileUserAgents"> <summary> Profile user agents. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileDisplayName"> <summary> Device profile display name. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileMacro"> <summary> Profile macro. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileName"> <summary> Device profile code name. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileID"> <summary> Device profile ID. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileOrder"> <summary> Device profile order. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileEnabled"> <summary> Enables or disables the device profile. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfilePreviewWidth"> <summary> Device profile preview width in pixels. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfilePreviewHeight"> <summary> Device profile preview height in pixels. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.ProfileGUID"> <summary> Device profile Guid. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfo.UsesExternalStorage"> <summary> Indicates whether the theme path points at an external storage. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfo.SetObjectOrderPostprocessing"> <summary> Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfo.#ctor"> <summary> Constructor - Creates an empty DeviceInfo object. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new DeviceInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfo.GetThemePath"> <summary> Gets the theme path for the object </summary> </member> <member name="T:CMS.DeviceProfiles.DeviceProfileInfoProvider"> <summary> Class providing Device profile management. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfoProvider.CurrentProfilesTable"> <summary> Table of the device profiles lists indexed by site user agent. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfoProvider.MaxDeviceProfilesEntries"> <summary> Maximum number of entries stored in CurrentProfilesTable. </summary> </member> <member name="P:CMS.DeviceProfiles.DeviceProfileInfoProvider.CurrentDeviceProfileName"> <summary> Current device profile name stored in cookie </summary> </member> <member name="F:CMS.DeviceProfiles.DeviceProfileInfoProvider.DEVICES_QUERY_PARAM"> <summary> Query parameter name for loading device profile from cookies. </summary> </member> <member name="F:CMS.DeviceProfiles.DeviceProfileInfoProvider.DEVICENAME_QUERY_PARAM"> <summary> Query parameter name for loading device profile from query. </summary> </member> <member name="F:CMS.DeviceProfiles.DeviceProfileInfoProvider.DEVICE_IMAGE_CACHE_KEY"> <summary> Name of cache key for automatic image resizing for device profiles. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetDeviceProfiles"> <summary> Returns all device profiles. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetDeviceProfileInfo(System.Int32)"> <summary> Returns device info with specified ID. </summary> <param name="infoId">Device info ID.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetDeviceProfileInfo(System.Guid,System.String)"> <summary> Returns device info with specified GUID. </summary> <param name="deviceGuid">Device GUID</param> <param name="siteName">Site name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetDeviceProfileInfo(System.String)"> <summary> Returns device info with specified name. </summary> <param name="infoName">Device info name.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.SetDeviceProfileInfo(CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Sets (updates or inserts) specified device info. </summary> <param name="infoObj">Device info to be set.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.DeleteDeviceProfileInfo(CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Deletes specified device info. </summary> <param name="infoObj">Device info to be deleted.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.DeleteDeviceProfileInfo(System.Int32)"> <summary> Deletes device info with specified ID. </summary> <param name="infoId">Device info ID.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.InitProfilesOrder"> <summary> Initialize profiles order. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.MoveProfileUp(System.Int32)"> <summary> Moves profile up. </summary> <param name="profileId">Profile ID</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.MoveProfileDown(System.Int32)"> <summary> Moves profile down. </summary> <param name="profileId">Profile ID</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetCurrentDeviceProfileInfo(System.String)"> <summary> Returns current device profile info. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetCurrentDeviceProfileInfo(System.String,System.Boolean)"> <summary> Returns current device profile info. </summary> <param name="siteName">Site name</param> <param name="loadFromCookies">Indicates if device profile is loaded from cookie instead of current browser device</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetOriginalCurrentDevicProfileName(System.String)"> <summary> Returns current original device profile name (cannot be overridden by URL parameter or cookie). </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetCurrentDevicProfiles(System.String)"> <summary> Returns ordered list of device profiles matching current device (can be overridden by URL parameter or cookie). </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.SetCurrentDeviceProfileInfo(System.String)"> <summary> Sets current device profile info. </summary> <param name="profileName">Device profile code name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetLastProfileOrder"> <summary> Returns order of the last profile. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.IsDeviceProfilesEnabled(System.String)"> <summary> Returns true if device profiles are enabled for given site. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.SetDeviceProfileInfoInternal(CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Sets (updates or inserts) specified device info. </summary> <param name="infoObj">Device info to be set.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.DeleteDeviceProfileInfoInternal(CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Deletes specified device info. </summary> <param name="infoObj">Device info to be deleted.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.ClearHashtables(System.Boolean)"> <summary> Clear hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.InitProfilesOrderInternal"> <summary> Initializes sorting order of profiles. </summary> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.MoveProfileUpInternal(System.Int32)"> <summary> Moves profile up. </summary> <param name="profileId">Profile ID</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.MoveProfileDownInternal(System.Int32)"> <summary> Moves profile up. </summary> <param name="profileId">Profile ID</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetCurrentDeviceProfilesInternal(System.String,System.Boolean,System.Boolean)"> <summary> 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). </summary> <param name="siteName">Site name</param> <param name="loadFromCookies">Indicates if device profile is loaded from cookie instead of current browser device</param> <param name="canBeOverridden">Indicates if device profile can be overridden by URL parameter or cookie at all.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.AddToCurrentProfilesTable(System.String,System.Collections.Generic.List{CMS.DeviceProfiles.DeviceProfileInfo})"> <summary> Adds list of current devices to dictionary and clears table if is too big. </summary> <param name="userAgent">User agent</param> <param name="profiles">List of profiles</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.ClearCurrentProfilesTable(System.Boolean)"> <summary> Clear hash table CurrentProfilesTable. </summary> <param name="logTask">If true, web farm tasks are logged</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.ClearCache(System.Int32)"> <summary> Clears cache for device profile. </summary> <param name="profileId">Device profile ID</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.ProcessWebFarmTask(System.String,System.String,System.Byte[])"> <summary> Runs the processing of specific web farm task for current provider </summary> <param name="actionName">Action name</param> <param name="data">Custom task data</param> <param name="binary">Binary data</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.GetCurrentDeviceProfileInfoInternal(System.String,System.Boolean,System.Boolean)"> <summary> Returns current device profile info. </summary> <param name="siteName">Site name</param> <param name="loadFromCookies">Indicates if device profile is loaded from cookie instead of current browser device</param> <param name="canBeOverridden">Indicates if device profile can be overridden by URL parameter or cookie at all.</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.LoadFromCookies(System.Boolean)"> <summary> Returns true if device info should be loaded from cookies. </summary> <param name="force">Force load</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.SetCurrentDeviceProfileInfoInternal(System.String)"> <summary> Sets current device profile info. </summary> <param name="profileName">Profile code name</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.IsCurrentProfile(System.String,CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Detects if given profile match current device. </summary> <param name="userAgent">Current user agent</param> <param name="info">Device profile info</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.IsCurrentProfileAgent(System.String,CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Returns true if device profile user agents list contains current user agent. </summary> <param name="userAgent">Current user agent string</param> <param name="info">Device profile information</param> </member> <member name="M:CMS.DeviceProfiles.DeviceProfileInfoProvider.IsCurrentProfileMacro(CMS.DeviceProfiles.DeviceProfileInfo)"> <summary> Returns true if given device profile macro is true. </summary> <param name="info">Device profile information</param> </member> <member name="T:CMS.DeviceProfiles.CurrentDeviceProvider"> <summary> Provides methods for retrieving the current device. </summary> </member> <member name="M:CMS.DeviceProfiles.CurrentDeviceProvider.GetCurrentDevice"> <summary> Gets current device information. </summary> <returns>Return current device information.</returns> </member> <member name="T:CMS.DeviceProfiles.ICurrentDeviceProvider"> <summary> Interface for the provider retrieving the current device. </summary> </member> <member name="M:CMS.DeviceProfiles.ICurrentDeviceProvider.GetCurrentDevice"> <summary> Gets the current device information. </summary> <returns>Return the current device information.</returns> </member> </members> </doc> |