Show / Hide Table of Contents

Class MailingsAndFoldersProvider

Combined archive of mailings (s_shipment) and mailing folders (s_picture_folder, folder_type = shipmentFolder) — analogous to EmailFlowsAndFoldersProvider.

Unified row schema (after the column-name overrides set up below):

  • PrimaryKey — row's own id
  • mailingFolderId — row's container folder id (for filtering)
  • name — display label (mailing description on mailings, folder name on folders), via overrides
  • thumbnail — preview image / folder icon hint (native on both)

Client filter mailingFolderId = N returns mailings whose s_shipment.FolderId = N AND folders whose s_picture_folder.ParentId = N — i.e. everything contained in folder N.

The name overrides are applied here (not by renaming the underlying extender columns) so MailingsExtenderBase keeps its native mailingDescription column for every OTHER archive that uses it (Contact / Person / Project / Sale cards). Same approach as EmailFlowsAndFoldersProvider (workflowName / hierarchyName both → name).

Inheritance
object
MultiQueryProviderBase
MailingsAndFoldersProvider
Implements
IArchiveMultiQueryProvider
IArchiveProvider
IArchiveProviderHasRows
IArchiveProviderHasColumns
IArchiveProviderHasEntities
Inherited Members
MultiQueryProviderBase.InnerPopulateRow(ArchiveRow)
MultiQueryProviderBase.AcceptRow(ArchiveRow)
MultiQueryProviderBase.PreGetRows()
MultiQueryProviderBase.GetFinalRowCount()
MultiQueryProviderBase.AddSubProvider<ProviderType>(ProviderType)
MultiQueryProviderBase.RemoveSubProvider<ProviderType>(ProviderType)
MultiQueryProviderBase.SetRestrictionAndDropUnrestrictedProviders(ArchiveRestrictionInfo[])
MultiQueryProviderBase.CreateAndAddProvidersAsync(MultiQueryProviderBase.AddProviderInfo[])
MultiQueryProviderBase.Close()
MultiQueryProviderBase.GetReaderAsync(string, CancellationToken)
MultiQueryProviderBase.GetRowsAsync(string, CancellationToken)
MultiQueryProviderBase.GetResultInformationAsync()
MultiQueryProviderBase.SetRestriction(ArchiveRestrictionInfo[])
MultiQueryProviderBase.SetPagingInfo(int, int)
MultiQueryProviderBase.GetAvailableColumns()
MultiQueryProviderBase.SetDesiredColumns(params string[])
MultiQueryProviderBase.SetOrderBy(ArchiveOrderByInfo[])
MultiQueryProviderBase.GetAvailableEntities()
MultiQueryProviderBase.SetDesiredEntities(params string[])
MultiQueryProviderBase.InhibitParallelStart
MultiQueryProviderBase.Options
MultiQueryProviderBase.OrderBy
MultiQueryProviderBase.InhibitDistinctPrimaryKeys
MultiQueryProviderBase.OrderByRequiresAll
MultiQueryProviderBase.RestrictionRequiresAll
MultiQueryProviderBase.OrderByRequired
MultiQueryProviderBase.RestrictionHelper
MultiQueryProviderBase.ColumnHelper
MultiQueryProviderBase.PageSize
MultiQueryProviderBase.PageNumber
MultiQueryProviderBase.HaveReadToEnd
MultiQueryProviderBase.Providers
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[ArchiveProvider("MailingsAndFolders", 1073741823)]
public class MailingsAndFoldersProvider : MultiQueryProviderBase, IArchiveMultiQueryProvider, IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntities

Constructors

MailingsAndFoldersProvider()

Combined archive of mailings (s_shipment) and mailing folders (s_picture_folder, folder_type = shipmentFolder) — analogous to EmailFlowsAndFoldersProvider.

Unified row schema (after the column-name overrides set up below):

  • PrimaryKey — row's own id
  • mailingFolderId — row's container folder id (for filtering)
  • name — display label (mailing description on mailings, folder name on folders), via overrides
  • thumbnail — preview image / folder icon hint (native on both)

Client filter mailingFolderId = N returns mailings whose s_shipment.FolderId = N AND folders whose s_picture_folder.ParentId = N — i.e. everything contained in folder N.

The name overrides are applied here (not by renaming the underlying extender columns) so MailingsExtenderBase keeps its native mailingDescription column for every OTHER archive that uses it (Contact / Person / Project / Sale cards). Same approach as EmailFlowsAndFoldersProvider (workflowName / hierarchyName both → name).

Declaration
public MailingsAndFoldersProvider()

Fields

ColName

Combined archive of mailings (s_shipment) and mailing folders (s_picture_folder, folder_type = shipmentFolder) — analogous to EmailFlowsAndFoldersProvider.

Unified row schema (after the column-name overrides set up below):

  • PrimaryKey — row's own id
  • mailingFolderId — row's container folder id (for filtering)
  • name — display label (mailing description on mailings, folder name on folders), via overrides
  • thumbnail — preview image / folder icon hint (native on both)

Client filter mailingFolderId = N returns mailings whose s_shipment.FolderId = N AND folders whose s_picture_folder.ParentId = N — i.e. everything contained in folder N.

The name overrides are applied here (not by renaming the underlying extender columns) so MailingsExtenderBase keeps its native mailingDescription column for every OTHER archive that uses it (Contact / Person / Project / Sale cards). Same approach as EmailFlowsAndFoldersProvider (workflowName / hierarchyName both → name).

Declaration
public const string ColName = "name"
Field Value
Type Description
string

ColThumbnail

Combined archive of mailings (s_shipment) and mailing folders (s_picture_folder, folder_type = shipmentFolder) — analogous to EmailFlowsAndFoldersProvider.

Unified row schema (after the column-name overrides set up below):

  • PrimaryKey — row's own id
  • mailingFolderId — row's container folder id (for filtering)
  • name — display label (mailing description on mailings, folder name on folders), via overrides
  • thumbnail — preview image / folder icon hint (native on both)

Client filter mailingFolderId = N returns mailings whose s_shipment.FolderId = N AND folders whose s_picture_folder.ParentId = N — i.e. everything contained in folder N.

The name overrides are applied here (not by renaming the underlying extender columns) so MailingsExtenderBase keeps its native mailingDescription column for every OTHER archive that uses it (Contact / Person / Project / Sale cards). Same approach as EmailFlowsAndFoldersProvider (workflowName / hierarchyName both → name).

Declaration
public const string ColThumbnail = "thumbnail"
Field Value
Type Description
string

ProviderName

Combined archive of mailings (s_shipment) and mailing folders (s_picture_folder, folder_type = shipmentFolder) — analogous to EmailFlowsAndFoldersProvider.

Unified row schema (after the column-name overrides set up below):

  • PrimaryKey — row's own id
  • mailingFolderId — row's container folder id (for filtering)
  • name — display label (mailing description on mailings, folder name on folders), via overrides
  • thumbnail — preview image / folder icon hint (native on both)

Client filter mailingFolderId = N returns mailings whose s_shipment.FolderId = N AND folders whose s_picture_folder.ParentId = N — i.e. everything contained in folder N.

The name overrides are applied here (not by renaming the underlying extender columns) so MailingsExtenderBase keeps its native mailingDescription column for every OTHER archive that uses it (Contact / Person / Project / Sale cards). Same approach as EmailFlowsAndFoldersProvider (workflowName / hierarchyName both → name).

Declaration
public const string ProviderName = "MailingsAndFolders"
Field Value
Type Description
string

Implements

IArchiveMultiQueryProvider
IArchiveProvider
IArchiveProviderHasRows
IArchiveProviderHasColumns
IArchiveProviderHasEntities

Extension Methods

IArchiverProviderHasRowsExtensions.GetRowsAsync(IArchiveProviderHasRows, CancellationToken)
EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top