Class FaqReplyTemplateProvider

Inheritance
object
FaqReplyTemplateProvider
FaqReplyTemplateFavouriteListProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("FaqReplyTemplate")]
[MDOAdditionalInfo("resultType", "Which of the types should be included? Comma separated string with the following choices: faqEntries, replyTemplates, quickReplies. Empty will give everything", "")]
public class FaqReplyTemplateProvider : ISoListProvider, ISoList

Constructors

FaqReplyTemplateProvider()

Declaration
public FaqReplyTemplateProvider()

Fields

ProviderName

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

_favouriteOnly

Declaration
protected bool _favouriteOnly
Field Value
Type Description
bool

_historyOnly

Declaration
protected bool _historyOnly
Field Value
Type Description
bool

_searchValue

Declaration
protected string _searchValue
Field Value
Type Description
string

Properties

HistoryInfo

History information for the supported list

Declaration
public HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo

Methods

ClearHistoryItems()

Clears the history items

Declaration
public void ClearHistoryItems()

ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)

Phase two of two-stage list construction. To be called right after the constructor, at which point all constructors have run, and the class hierarchy is initialized.

Declaration
public virtual Task ConstructAsync(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string listName

List name (though note that as implemented by MDOProviderBase, this actually has to be a real table name, so subclasses should override and convert from their list name to a real table name) (yes it's a bit messy)
string additionalInfo

Additional information to provider
int[] historyIDs

Array of history ID's; if non-null, this will BE the history; a non-null but empty array will disable reading of history altogether; a null parameter will cause history to be read from the database.
bool onlyReadHistory

if true, only history will be read.
string searchValue

If non-null, the returned list will be flat and only consist of search matches
bool forceFlatList

If true, the returned list will be flat, though it will still be filtered if grouping/filtering has been set up for the list
CancellationToken cancellationToken
Returns
Type Description
Task

GetHeadingItemsAsync(CancellationToken)

list of headings

Declaration
public Task<List<ISoListHeading>> GetHeadingItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListHeading>>

GetHistoryItemsAsync(CancellationToken)

list of history items

Declaration
public Task<List<ISoListItem>> GetHistoryItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>

GetRootItemsAsync(CancellationToken)

list of root-level items (items not under any heading)

Declaration
public Task<List<ISoListItem>> GetRootItemsAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<List<ISoListItem>>

Implements

Extension Methods