Edit

ISerializedServerProcessedData interface

  • Reference
Package:
@microsoft/sp-component-base

Contains collections of data that can be processed by server side services like search index and link fixup

Properties

htmlStrings

A key-value map where keys are string identifiers and values are rich text with HTML format.
imageSources

A key-value map where keys are string identifiers and values are image sources.
links

A key-value map where keys are string identifiers and values are links.
searchablePlainTexts

A key-value map where keys are string identifiers and values are strings that should be search indexed.

Property Details

htmlStrings

A key-value map where keys are string identifiers and values are rich text with HTML format.

htmlStrings?: {
        [key: string]: string;
    };

Property Value

{ [key: string]: string; }

Remarks

SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them.

Example:

{
  'myRichDescription': '<div>Some standard <b>HTML content</b><a href='http://somelink'>A Link</a></div>'
  'anotherRichText': <div class='aClass'><span style='color:red'>Some red text</div>
}

imageSources

A key-value map where keys are string identifiers and values are image sources.

imageSources?: {
        [key: string]: string;
    };

Property Value

{ [key: string]: string; }

Remarks

SharePoint servers treat the values as image sources and run services like search index and link fixup on them.

Example:

{
  'myImage1': 'http://res.contoso.com/path/to/file'
  'myImage2': 'https://res.contoso.com/someName.jpg'
}

A key-value map where keys are string identifiers and values are links.

links?: {
        [key: string]: string;
    };

Property Value

{ [key: string]: string; }

Remarks

SharePoint servers treat the values as links and run services like link fixup on them.

Example:

{
  'myWebURL': 'http://contoso.com'
  'myFileLink': 'https://res.contoso.com/file.docx'
}

searchablePlainTexts

A key-value map where keys are string identifiers and values are strings that should be search indexed.

searchablePlainTexts?: {
        [key: string]: string;
    };

Property Value

{ [key: string]: string; }

Remarks

The values are HTML-encoded before being sent to the server. The encoded values are visible to the search indexer, but are not treated as valid HTML. So, other services such as link fixup will not run on them.

Example:

{
 'justSomeText': 'This is some plain text',
 'anotherText': 'Can have <any> characters here: "<>&\''
}