MFWED_ApiTypes Class

Global class containing types used in the WebEditor API.

Namespace

mfwe

Classes

DynamoFolderResponse Class

Folder information from Dynamo

Fields

Description

AURAENABLED

Folder name, description

Signature

global Description

Type

String

Name

AURAENABLED

Name of the folder

Signature

global Name

Type

String

Table

AURAENABLED

The table name

Signature

global Table

Type

String

Col

AURAENABLED

List of columns in the folder

Signature

global Col

Type

List<ColumnNode>

error

AURAENABLED

Error message if any

Signature

global error

Type

String

ColumnNode Class

Column information from Dynamo

Fields

Attr

AURAENABLED

Column attribute

Signature

global Attr

Type

String

ColName

AURAENABLED

Column name

Signature

global ColName

Type

String

DefaultValue

AURAENABLED

Column default values

Signature

global DefaultValue

Type

String

LabelIndex

AURAENABLED

Label index

Signature

global LabelIndex

Type

String

Length

AURAENABLED

Column length

Signature

global Length

Type

String

Mandatory

AURAENABLED

Column mandatory or not

Signature

global Mandatory

Type

Integer

NotNULL

AURAENABLED

Column type null or not

Signature

global NotNULL

Type

Integer

Type

AURAENABLED

Column type

Signature

global Type

Type

String

OnlineDocuments Class

A hierarchical list of ALL templates from Metaforce. Use keywords to filter out relevant templates.

Fields

Root

AURAENABLED

Root node of the document tree

Signature

global Root

Type

DocumentNode

Distributions

AURAENABLED

List of distribution methods

Signature

global Distributions

Type

List<String>

error

AURAENABLED

Error message if any

Signature

global error

Type

String

userClassifications

AURAENABLED

User classifications

Signature

global userClassifications

Type

Map<String,Boolean>

DocumentNode Class

A hierarchical list of templates from Metaforce. Use keywords to filter out relevant templates.

Fields

Name

AURAENABLED

Name of the document

Signature

global Name

Type

String

Documents

AURAENABLED

List of documents

Signature

global Documents

Type

List<Template>

ChildNodes

AURAENABLED

List of child nodes

Signature

global ChildNodes

Type

List<DocumentNode>

Template Class

Template details from Metaforce.

Fields

Name

AURAENABLED

Template name

Signature

global Name

Type

String

Description

AURAENABLED

Template description

Signature

global Description

Type

String

AttributeStoreKey

AURAENABLED

Attribute store key if any

Signature

global AttributeStoreKey

Type

String

HasProcess

AURAENABLED

True if template has process, e.g. will launch web editor

Signature

global HasProcess

Type

Boolean

KeyWords

AURAENABLED

List of all keywords the template has, Keywords are typically: ‘USERSELECTABLE’, ‘SOBJECT’, ‘RECEIVERINTEMPLATE’ etc

Signature

global KeyWords

Type

List<String>

ArchiveSearchResponse Class

List of all documents, with its metadata, found when searching Metaforce archive.

Fields

DocumentModel

AURAENABLED

List of document models

Signature

global DocumentModel

Type

List<DocumentModelCls>

Count

AURAENABLED

Total count of documents found

Signature

global Count

Type

Integer

error

AURAENABLED

Error message if any

Signature

global error

Type

String

DocumentModelCls Class

Document details from Metaforce archive.

Fields

ArchiveDate

AURAENABLED

Archiving date and time

Signature

global ArchiveDate

Type

Datetime

id

AURAENABLED

Document id

Signature

global id

Type

String

ContentType

AURAENABLED

Content type of the document

Signature

global ContentType

Type

String

Metadata

AURAENABLED

Map of metadata fields

Signature

global Metadata

Type

Map<String,String>

PartitionKey

AURAENABLED

Partition key

Signature

global PartitionKey

Type

String

SearchSpec Class

Class used for creating an archive search specification, Metaforce metadata field name, value and compare operator. Valid values for comparer are: ‘AND’ or ‘OR’.

Fields

key

AURAENABLED

Metaforce metadata field name

Signature

global key

Type

String

value

AURAENABLED

Metaforce metadata field value

Signature

global value

Type

String

comparer

AURAENABLED

Compare operator, ‘AND’ or ‘OR’

Signature

global comparer

Type

String

Constructors

SearchSpec(key, value, comparer)

Constructor for search spec

Signature

global SearchSpec(String key, String value, String comparer)

Parameters

ArchiveSchemaResponse Class

This class contains all schema details from Metaforce. Used by getSchemas() method.

Fields

Name

AURAENABLED

Name of the schema

Signature

global Name

Type

String

PartitionKey

AURAENABLED

Schema partition key

Signature

global PartitionKey

Type

String

AllowedScopes

AURAENABLED

List of allowed scopes

Signature

global AllowedScopes

Type

List<String>

RequiredSearchFields

AURAENABLED

List of required search fields

Signature

global RequiredSearchFields

Type

List<String>

EncryptedColumns

AURAENABLED

List of all encrypted columns in the schema

Signature

global EncryptedColumns

Type

EncryptedColumn

Schema

AURAENABLED

The schema with type, properties and list of required fields

Signature

global Schema

Type

SchemaClass

Columns

AURAENABLED

List of all columns in the schema

Signature

global Columns

Type

List<ColumnClass>

error

AURAENABLED

Error message if any

Signature

global error

Type

String

ColumnClass Class

Class representing each column with name and type in the schema

Fields

Name

AURAENABLED

Column name

Signature

global Name

Type

String

Type

AURAENABLED

Column type

Signature

global Type

Type

String

SchemaClass Class

Fields

type

AURAENABLED

Schema type

Signature

global type

Type

String

additionalProperties

AURAENABLED

Additional properties for Schema exists or not

Signature

global additionalProperties

Type

Boolean

required

AURAENABLED

List of required fields

Signature

global required

Type

List<String>

EncryptedColumn Class

Class representing all encrypted columns in the schema

Fields

DataColumns

AURAENABLED

List of encrypted columns

Signature

global DataColumns

Type

List<String>

SorterCls Class

Class used for creating a dynamo search specification, Metaforce metadata field name, value and compare operator. Valid values for comparer are: ‘AND’ or ‘OR’.

Fields

column

Column name to sort on

Signature

global column

Type

String

sortOrder

Sort order, ‘ASC’ or ‘DESC’

Signature

global sortOrder

Type

String

Constructors

SorterCls()

Default constructor for sorter

Signature

global SorterCls()

SorterCls(column, sortOrder)

Constructor for sorter to set column name and sort order

Signature

global SorterCls(String column, String sortOrder)

Parameters

WhereConditionsCls Class

Class used for creating a dynamo search specification, Metaforce metadata field name, etc

Fields

value

Metaforce metadata field value

Signature

global value

Type

String

comparer

Compare operator, e.g. ‘EQ’, ‘NE’, ‘GT’, ‘LT’, ‘GE’, ‘LE’

Signature

global comparer

Type

String

column

Metaforce metadata field name

Signature

global column

Type

String

chainer

Chainer, ‘AND’ or ‘OR’

Signature

global chainer

Type

String

Constructors

WhereConditionsCls()

Default constructor for where conditions

Signature

global WhereConditionsCls()

WhereConditionsCls(value, comparer, column, chainer)

Constructor for where conditions to set value, comparer, column and chainer

Signature

global WhereConditionsCls(String value, String comparer, String column, String chainer)

Parameters

DynamoSearchResponse Class

List of all documents, with its metadata, found when searching Metaforce dynamo.

Fields

Columns

AURAENABLED

List of search column objects

Signature

global Columns

Type

List<DynamoSearchColumnObject>

error

AURAENABLED

Error message if any

Signature

global error

Type

String

Constructors

DynamoSearchResponse()

Default constructor for dynamo search response

Signature

global DynamoSearchResponse()

DynamoSearchColumnObject Class

Class representing each column with name and value in the dynamo search response

Fields

name

AURAENABLED

Column name

Signature

global name

Type

String

value

AURAENABLED

Column value

Signature

global value

Type

String

Constructors

DynamoSearchColumnObject(name, value)

Constructor for dynamo search column object

Signature

global DynamoSearchColumnObject(String name, String value)

Parameters

ArchiveUploadResponse Class

Document details from uploading document to archive

Fields

id

AURAENABLED

Document id

Signature

global id

Type

String

partitionKey

AURAENABLED

Partition key

Signature

global partitionKey

Type

String

archiveDate

AURAENABLED

Archive date

Signature

global archiveDate

Type

String

retentionPolicy

AURAENABLED

retention policy

Signature

global retentionPolicy

Type

String

contentType

AURAENABLED

Content type

Signature

global contentType

Type

String

metadata

AURAENABLED

Map of metadata, key value pairs

Signature

global metadata

Type

Map<String,String>

error

AURAENABLED

Error message if any

Signature

global error

Type

String

ArchiveUpdateMetadataResponse Class

Document details from updating document metadata in archive

Fields

id

AURAENABLED

Document id

Signature

global id

Type

String

partitionKey

AURAENABLED

Partition key

Signature

global partitionKey

Type

String

archiveDate

AURAENABLED

Archive date

Signature

global archiveDate

Type

String

DistributeSendResponse Class

Document details from sending and distributing a document

Fields

CorrelationId

AURAENABLED

Correlation id

Signature

global CorrelationId

Type

String

Id

AURAENABLED

DescriptionDocument

id

Signature

global Id

Type

String

Distribution

AURAENABLED

Distribution method

Signature

global Distribution

Type

String

JobId

AURAENABLED

Job id of the document

Signature

global JobId

Type

String

DocId

AURAENABLED

Doc id of the document

Signature

global DocId

Type

String

error

AURAENABLED

Error message if any

Signature

global error

Type

String

ComplexNode Class

The ComplexNode class represents a hierarchy of data nodes. Each node represents a data element with attributes and children. The data element is typically a Salesforce record.

Fields

name

Name of the node

Signature

global name

Type

String

attributes

Map of attributes for the node, key value pairs

Signature

global attributes

Type

Map<String,String>

children

List of children nodes, building up the hierarchy

Signature

global children

Type

List<ComplexNode>

Constructors

ComplexNode(SObjectName, recordId, templateName, description)

Default constructor for ComplexNode

Signature

global ComplexNode(String SObjectName, String recordId, String templateName, String description)

Parameters

ComplexNode(name)

Simple constructor for ComplexNode with name only

Signature

global ComplexNode(String name)

Parameters

Methods

addAttribute(key, value)

Add an attribute to the node.

Signature

global ComplexNode addAttribute(String key, String value)

Parameters

Return Type

ComplexNode

The node with the added attribute. Reuse the node for chaining.

addChild(node)

Add a child node to the node.

Signature

global ComplexNode addChild(ComplexNode node)

Parameters

Return Type

ComplexNode

The node with the added child. Reuse the node for chaining.

addChildren(nodes)

Add a list of child nodes to the node.

Signature

global ComplexNode addChildren(List<ComplexNode> nodes)

Parameters

Return Type

ComplexNode

The node with the added children. Reuse the node for chaining.

KeyValueData Class

Class representing a key value pair with a type

Fields

key

AURAENABLED

Key of the key value pair

Signature

global key

Type

String

value

AURAENABLED

Value of the key value pair

Signature

global value

Type

String

type

AURAENABLED

Type of the key value pair

Signature

global type

Type

String

Constructors

KeyValueData(key, value)

Constructor for key value pair, defaulting to String type

Signature

global KeyValueData(String key, String value)

Parameters

KeyValueData(key, value, type)

Constructor for key value pair, explicitly stating type

Signature

global KeyValueData(String key, String value, String type)

Parameters

WebEditDocumentResponse Class

Wrapper class for result from creating a webeditor session

Fields

DxmlUID

Resulting dxml unique Id, identifies the webeditor document session

Signature

global DxmlUID

Type

String

StartURL

URL to start the webeditor session

Signature

global StartURL

Type

String

ValidTo

Valid to date and time for the webeditor session

Signature

global ValidTo

Type

Datetime

error

Error message if any

Signature

global error

Type

String

Constructors

WebEditDocumentResponse(DxmlUID, StartURL, ValidTo, error)

Constructor for WebEditDocumentResponse

Signature

global WebEditDocumentResponse(String DxmlUID, String StartURL, Datetime ValidTo, String error)

Parameters

Attribute Class

Wrapper class for result from retrieving attribute store from Metaforce

Fields

name

AURAENABLED

Name of the attribute

Signature

global name

Type

String

value

AURAENABLED

Value of the attribute

Signature

global value

Type

String

Constructors

Attribute(name, value)

Constructor for Attribute

Signature

global Attribute(String name, String value)

Parameters

AttributeDocumentDetail Class

Wrapper class for result from retrieving attribute store from Metaforce

Fields

attributes

AURAENABLED

List of attributes

Signature

global attributes

Type

List<Attribute>

Methods

addAttribute(name, value)

Constructor for AttributeDocumentDetail

Signature

global AttributeDocumentDetail addAttribute(String name, String value)

Parameters

Return Type

AttributeDocumentDetail

The AttributeDocumentDetail with the added attribute. Reuse the AttributeDocumentDetail for chaining.

AttributeDocument Class

Wrapper class for result from retrieving attribute document from Metaforce

Fields

id

AURAENABLED

Attribute Document id

Signature

global id

Type

String

type

AURAENABLED

Attribute Document type

Signature

global type

Type

String

AttributeStore Class

Wrapper class for result from retrieving attribute store from Metaforce

Fields

environment

AURAENABLED

Environment of the attribute store

Signature

global environment

Type

Integer

documents

AURAENABLED

List of attribute documents

Signature

global documents

Type

List<AttributeDocument>

Constructors

AttributeStore()

Default constructor for AttributeStore

Signature

global AttributeStore()

Enums

SourceFormat Enum

Source format for the document to be uploaded to Metaforce.

Values