AvatarInfoProvider Class

Class providing AvatarInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<AvatarInfo, AvatarInfoProvider, ObjectQuery<AvatarInfo>>
    CMS.DataEngine.AbstractInfoProvider<AvatarInfo, AvatarInfoProvider>
      CMS.Membership.AvatarInfoProvider

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 12.0.0

Syntax

public class AvatarInfoProvider : AbstractInfoProvider<AvatarInfo, AvatarInfoProvider>

The AvatarInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	AvatarInfoProvider

Fields

	Name	Description
Public field Static member	AVATAR	Constant for avatar option
Public field Static member	GRAVATAR	Constant for gravatar option
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public field Static member	USERCHOICE	Constant for user choice option

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	WebApplicationPhysicalPath	Full path to the root of the web.

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CanResizeImage	Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ClearDefaultAvatar(DefaultAvatarTypeEnum)	Clears specified default avatar type from all avatars.
Public method Static member	ClearDefaultAvatar(DefaultAvatarTypeEnum, Boolean)	Clears specified default avatar type from all avatars.
Public method Static member	ClearDefaultAvatar(DefaultAvatarTypeEnum, Boolean, Boolean)	Clears specified default avatar type from all avatars.
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CreateGravatarLink	Creates URL for gravatar image
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteAvatarFile	Delete avatar file stored in the file system.
Public method Static member	DeleteAvatarInfo(Int32)	Deletes specified avatar.
Public method Static member	DeleteAvatarInfo(AvatarInfo)	Deletes specified avatar.
Protected method	DeleteAvatarInfoInternal	Deletes specified avatar.
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	EnsureAvatarPhysicalFile	Ensures the avatar file in the file system and returns the path to the file.
Public method Static member	EnsureThumbnailFile	Ensures the thumbnail avatar.
Public method Static member	GenerateThumbnails	Returns the current settings whether the thumbnails should be generated.
Public method Static member	GetAvatarFile(Guid)	Returns the avatar file from disk or (if not available on the disk) from database.
Public method Static member	GetAvatarFile(AvatarInfo)	Returns the file from disk or (if not available on the disk) from database.
Public method Static member	GetAvatarFileBinary	Returns the file binary from database and save it in file system
Public method Static member	GetAvatarInfo(Guid)	Returns the AvatarInfo structure for the specified avatar.
Public method Static member	GetAvatarInfo(Int32)	Returns the AvatarInfo structure for the specified avatar.
Public method Static member	GetAvatarInfo(String)	Returns the AvatarInfo structure for the specified avatar.
Protected method	GetAvatarInfoInternal	Returns the AvatarInfo structure for the specified avatar.
Public method Static member	GetAvatarInfoWithoutBinary(Guid)	Returns the AvatarInfo structure for the specified avatar.
Public method Static member	GetAvatarInfoWithoutBinary(Int32)	Returns the AvatarInfo structure for the specified avatar.
Public method Static member	GetAvatarInfoWithoutBinary(String)	Returns the AvatarInfo structure for the specified avatar.
Protected method	GetAvatarInfoWithoutBinaryInternal(Guid)	Returns the AvatarInfo structure for the specified avatar.
Protected method	GetAvatarInfoWithoutBinaryInternal(Int32)	Returns the AvatarInfo structure for the specified avatar.
Protected method	GetAvatarInfoWithoutBinaryInternal(String)	Returns the AvatarInfo structure for the specified avatar.
Public method Static member	GetAvatars	Returns the query for all avatars.
Public method Static member	GetAvatarTypeEnum	Returns the enum representation of avatar type based on specified string.
Public method Static member	GetAvatarTypeString(AvatarTypeEnum)	Returns the string representation of avatar type based on specified enum value.
Public method Static member	GetAvatarTypeString(Type, Int32)	Returns AvatarTypeEnum string code derived from type of enumeration and enum value.
Public method Static member	GetDefaultAvatar(DefaultAvatarTypeEnum)	Returns default avatar of specified type or null if such is not set.
Public method Static member	GetDefaultAvatar(UserGenderEnum)	Gets default avatar info based on user gender
Public method	GetDefaultAvatarInternal	Returns default avatar of specified type or null if such is not set.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetFilePhysicalPath	Returns physical path to the file.
Public method Static member	GetFilesFolderPath	Returns physical path to folder with avatar files which are associated with the specified site.
Public method Static member	GetGravatarDefaultParameter	Returns parameter for default gravatar image
Public method Static member	GetImageThumbnail	Returns image thumbnail (from the disk - if already exists, or create new one and save it to disk - if doesn't exist).
Public method Static member	GetImageThumbnailFile	Returns the image thumbnail from the disk.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetUniqueAvatarName	Returns unique name for avatar.
Public method Static member	GetUserAvatarImage	Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method Static member	GetUserAvatarImageByGUID	Returns user avatar image.
Public method Static member	GetUserAvatarImageForUser	Returns avatar image tag, if avatar is not defined returns gender depend avatar or user default avatar if is defined.
Public method Static member	GetUserAvatarImageUrl	Returns avatar or gravatar image url, if it is not defined returns gender dependent avatar or user default avatar.
Protected method	GetUserAvatarImageUrlInternal	Returns avatar or gravatar image url, if it is not defined returns gender dependent avatar or user default avatar.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTask(String, String, Byte[]).)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SaveAvatarFileToDisk	Saves avatar file to the disk.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetAvatarInfo	Sets (updates or inserts) specified avatar.
Protected method	SetAvatarInfoInternal	Sets (updates or inserts) specified avatar.
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	UploadAvatar	Uploads and resizes (if needed) avatar to specified AvatarInfo and sets its properties.
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)