ogcItemToDiscussionPostResult

Function

This method is responsible for converting an OGC item whose properties represent an IPost into an IHubSearchResult. Although some fields do not apply, this is being done such that result of a discussion post search can automatically be used in a gallery.

ogcItemToDiscussionPostResult(ogcItem: IOgcItem) : Promise<IHubSearchResult>

Parameters

Parameter	Type	Default	Notes
ogcItem Required	IOgcItem

Returns

IHubSearchResult

Promise<IHubSearchResult>

Property	Type	Notes
access	AccessLevel	Access level of the backing entity
family	HubFamily	Hub Family
createdDate Inherited	Date	Date the entity was created
createdDateSource Inherited	string	Source of the creation date as a property path e.q `item.created`
id Inherited	string	Id of the entity as a string
name Inherited	string	Name of the Entity For Entities backed by items, this is typically the title
type Inherited	string	For Item backed results, this will be `item.type` Otherwise it will be "Group", "User", "Event" etc
updatedDate Inherited	Date	Date when the entity was last updated Depending on the entity, this could be derived in many different ways
updatedDateSource Inherited	string	Source of the updated date
categories Optional	string[]	Categories; Applies to Items
geometry Optional	IHubGeography
location Optional	IHubLocation	Custom location defined on the item properties (item.properties.location), typically created in details pane of entity workspace.
owner Optional	string	Owner; Applies to Items and Groups
rawResult Optional	IItem \| IGroup \| IUser \| IOgcItem \| IChannel \| IEvent \| IRegistration	Raw result object returned from the search. This allows downstream processing to access additional properties that may not be explicitly defined in this interface Note: We will need to cast to the approproate type in order to access the properties
tags Optional	string[]	Tags; Applies to Items
typeKeywords Optional	string[]	TypeKeywords; Applies to Items
links Optional Inherited	IHubEntityLinks	Links to related things
source Optional Inherited	string	Source of the entity. Exact logic for this tbd, but the intent is to allow the result to be attributed to something other than "owner"
summary Optional Inherited	string	Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc

Function defined in common/src/search/_internal/hubSearchItemsHelpers/ogcItemToDiscussionPostResult.ts:12