AttachmentInfoProvider Class

Class providing attachment management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<AttachmentInfo, AttachmentInfoProvider, ObjectQuery<AttachmentInfo>>
    CMS.DataEngine.AbstractInfoProvider<AttachmentInfo, AttachmentInfoProvider>
      CMS.DocumentEngine.AttachmentInfoProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public class AttachmentInfoProvider : AbstractInfoProvider<AttachmentInfo, AttachmentInfoProvider>, 
	IAttachmentInfoProvider, IInfoProvider<AttachmentInfo>, IInfoByIdProvider<AttachmentInfo>, 
	IInfoBySiteAndGuidProvider<AttachmentInfo>

The AttachmentInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	AttachmentInfoProvider	Initializes a new instance of an AttachmentInfoProvider.

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public field Static member	MAXATTACHMENTNAMELENGTH	Maximal length of the attachment name.

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>.)

Methods

	Name	Description
Public method Static member	AddTemporaryAttachment(Guid, Guid, Guid, IUploadedFile, Int32, Int32, Int32, Int32)	Adds the temporary attachment to the document, updates the attachment if currently present.
Public method	AddTemporaryAttachment(Guid, Guid, Guid, String, Int32, Int32, Int32, Int32)	Adds the temporary attachment to the document, updates the attachment if currently present.
Public method Static member	AddTemporaryAttachment(Guid, Guid, Guid, HttpPostedFile, Int32, Int32, Int32, Int32)	Obsolete. Adds the temporary attachment to the document, updates the attachment if currently present.
Public method Static member	AddTemporaryAttachment(Guid, String, Guid, Guid, AttachmentSource, Int32, Int32, Int32, Int32)	Adds the temporary attachment to the document, updates the attachment if currently present.
Protected method	AddTemporaryAttachmentInternal	Adds the temporary attachment to the document, updates the attachment if currently present.
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	CheckFilesPermissions	Returns the current settings whether the files should check document permissions.
Public method Static member	CheckPublishedFiles	Returns the current settings whether the files should check if the document is published.
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>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ClearSearchCache	Clears the AttachmentSearchContent for all attachments in the DB.
Protected method	ClearSearchCacheInternal	Clears the AttachmentSearchContent for all attachments in the DB.
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	Delete	Deletes the info object from the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Delete(TInfo).)
Public method Static member	DeleteAttachmentInfo(Int32, Boolean)	Obsolete. Deletes specified attachment.
Public method Static member	DeleteAttachmentInfo(AttachmentInfo, Boolean)	Obsolete. Deletes specified attachment.
Protected method	DeleteAttachmentInfoInternal	Obsolete. Deletes specified attachment.
Public method Static member	DeleteAttachments	Deletes all the attachments of specified document.
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	DeleteOldTemporaryAttachments	Deletes old temporary attachments.
Protected method	DeleteOldTemporaryAttachmentsInternal	Deletes old temporary attachments.
Public method Static member	DeleteTemporaryAttachment	Adds the temporary attachment to the document, updates the attachment if currently present.
Public method Static member	DeleteTemporaryAttachments	Deletes old temporary attachments.
Protected method	DeleteTemporaryAttachmentsInternal	Deletes old temporary attachments.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetAttachmentInfo(Guid, String)	Obsolete. Returns the AttachmentInfo structure for the specified attachment.
Public method Static member	GetAttachmentInfo(Int32, Boolean)	Obsolete. Returns the AttachmentInfo structure for the specified attachment.
Public method Static member	GetAttachmentInfo(Int32, Guid)	Gets the attachment by the document ID and attachment GUID.
Public method Static member	GetAttachmentInfo(String, String)	Obsolete. Returns the AttachmentInfo structure for the specified attachment.
Public method Static member	GetAttachmentInfo(Int32, String, Boolean)	Gets the attachment by the document ID and file name.
Protected method	GetAttachmentInfoInternal(Guid, String)	Obsolete. Returns the AttachmentInfo structure for the specified attachment.
Protected method	GetAttachmentInfoInternal(Int32, Boolean)	Obsolete. Returns the AttachmentInfo structure for the specified attachment.
Protected method	GetAttachmentInfoInternal(Int32, Guid)	Gets the attachment by the document ID and attachment GUID.
Protected method	GetAttachmentInfoInternal(Int32, String, Boolean)	Gets the attachment by the document ID and file name.
Public method Static member	GetAttachmentInfoWithoutBinary	Obsolete. Returns the AttachmentInfo structure for the specified attachment without binary data.
Protected method	GetAttachmentInfoWithoutBinaryInternal	Obsolete. Returns the AttachmentInfo structure for the specified attachment without binary data.
Public method Static member	GetAttachments()	Obsolete. Gets the query for all attachments
Public method Static member	GetAttachments(Int32, Boolean)	Returns object query of attachments with specified document id.
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	GetDependencyCacheKeys(Int32)	Gets the cache key dependencies array for the attachment order change (cache item keys affected when the attachment order changes).
Public method Static member	GetDependencyCacheKeys(IAttachment)	Gets the cache key dependencies array for the attachment (cache item keys affected when the attachment changes).
Protected method	GetDependencyCacheKeysInternal(Int32)	Gets the cache key dependencies array for the attachment order change (cache item keys affected when the attachment order changes).
Protected method	GetDependencyCacheKeysInternal(IAttachment)	Gets the cache key dependencies array for the attachment (cache item keys affected when the attachment changes).
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	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously 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	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously 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	GetInfoByIdAsync	Asynchronously 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	GetTemporaryAttachmentInfo	Gets a temporary attachment
Public method Static member	GetUniqueTemporaryAttachmentFileName	Method gets unique temporary attachment file name in the form scope.
Protected method	GetUniqueTemporaryAttachmentFileNameInternal	Method gets unique temporary attachment file name in the form scope.
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>.)
Public method Static member	IsUniqueTemporaryAttachmentName	Finds out whether the given temporary attachment file name is unique.
Protected method	IsUniqueTemporaryAttachmentNameInternal	Indicates whether the given temporary attachment name is unique.
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 Static member	MoveAttachment	Moves the attachment data to the target site.
Protected method	MoveAttachmentInternal	Moves the attachment data to the target site.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetAttachmentInfo	Obsolete. Sets (updates or inserts) specified attachment.
Protected method	SetAttachmentInfoInternal	Obsolete. Sets (updates or inserts) specified attachment.
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	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Extension Methods

	Name	Description
Public Extension Method	GetWithoutBinary(Int32)	Overloaded. Gets an instance of attachment based on its ID. (Defined by AttachmentInfoProviderExtensions.)
Public Extension Method	GetWithoutBinary(Guid, Int32)	Overloaded. Gets an instance of attachment based on its GUID and site ID. (Defined by AttachmentInfoProviderExtensions.)