Class ArchiveConfiguration
This service is used to store and fetch the configuration of an archive. The configuration consists of entities and columns; entities correspond to archive provider entities and the checkboxes you see in the bottom of standard archives. Column configuration includes both what columns should be visible, what order they are in (left to right), and whether the archive rows should be sorted by one or more columns.<para/>Note that desired columns can be set through the selectable mdo list called archiveColumns:<perovider name>, and entities can be set through the selectable mdo list archiveEntities:<provider name>. You can also use the SetChosenEntities and SetChosenColumns method of this service. The selectable mdo list implementation is suitable for data binding using mdo list controls.
Carrier object for ArchiveConfiguration. Services for the ArchiveConfiguration Carrier is available from the Archive Agent.
Namespace: SuperOfficeCRMServices
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class ArchiveConfiguration : Carrier
Constructors
ArchiveConfiguration()
Default constructor
Declaration
public ArchiveConfiguration()
Properties
ArchiveColumnInfo
Declaration
[DataMember]
public virtual ArchiveColumnInfo[] ArchiveColumnInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo |
ArchiveEntityInfo
Declaration
[DataMember]
public virtual SelectableMDOListItem[] ArchiveEntityInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| SelectableMDOListItem |
ArchiveOrderByInfo
Declaration
[DataMember]
public virtual ArchiveOrderByInfo[] ArchiveOrderByInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| ArchiveOrderByInfo |
OwnerKeys
The actual ownership information for the configuration that was retrieved
Declaration
[DataMember]
public virtual string OwnerKeys { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
ToString(string)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)
Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |