Skip to main content

Class NewsFeedItem

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for NewsFeedItem. News feed items are created by agents or other services for display on the start page and other relevant places in the UI.

Inheritance

objectNewsFeedItem

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get NewsFeedItem 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new NewsFeedAgent(configuration);
var newsFeedItem = agent.GetNewsFeedItem( 123 );

Remarks

Use : All NewsFeedItem:
“NewsFeedItem”

Constructors

NewsFeedItem()

Default constructor - defaults any enum props to 0.

Properties

Actions

Call to action items for the news feed item. Each item contains a title, an identifier, a type and flavor.

Property Value

NewsFeedCTA[]

ApplicationId

The id of the application that registered this news item. Used to resolve where any CTA should be posted when clicked.

Property Value

string

Contact

Company that is mentioned in the news feed item - null if not applicable

Property Value

Contact

Description

Multi-language descriptions for the news feed item, where the key is an ISO 2 letter language code (e.g. ‘en’, ‘no’, ‘de’) and the value is the description in that language. Styling via pre-defined CSS classes. No SCRIPT or STYLE tags allowed. The ‘current’ value is set based on the Accept-Language/SO-Language header.

Property Value

StringDictionary

ExpiresAt

When the news item expires and should no longer be shown in feeds (UTC)

Property Value

DateTime

FromCategoryName

Type of the instance that published this item. e.g. Prospector Agent

Property Value

string

FromName

Name of the instance that published this item. e.g. Pete the prospector

Property Value

string URL Link to an image associated with the news item.

Property Value

string

IsRead

Set to true when the recipient user has read the news feed item.

Property Value

bool

NewsFeedItemId

Primary key

Property Value

int

Person

Person that is mentioned in the news feed item - null if not applicable

Property Value

Person

PreviewHint

Preview hint for the news item. e.g. {contact_id=123}

Property Value

string

Priority

Importance of the news item. Low to High. Higher priority items may be shown more prominently in the feed. NULL if unknown enum value.

Property Value

EMailPriority?

See Also

NewsFeedItem.Priority_String

Priority_String

Importance of the news item. Low to High. Higher priority items may be shown more prominently in the feed. Raw string enum value.

Property Value

string

See Also

NewsFeedItem.Priority

Project

Project that is mentioned in the news feed item - null if not applicable

Property Value

Project

ReadAt

When the recipient user read the news feed item (UTC)

Property Value

DateTime

Registered

Registered when

Property Value

DateTime

Sale

Sale that is mentioned in the news feed item - null if not applicable

Property Value

Sale URL Link to the source of the news item, or an SOProtocol link to a SuperOffice item

Property Value

string

Status

Indicates if the item is being handled by a CTA. (normal, processing, processed) NULL if unknown enum value.

Property Value

NewsFeedItemStatus?

See Also

NewsFeedItem.Status_String

Status_String

Indicates if the item is being handled by a CTA. (normal, processing, processed) Raw string enum value.

Property Value

string

See Also

NewsFeedItem.Status

Summary

Short, descriptive summary. Plain text summary. Multi-language string supported: ‘US:“english”;NO:“norsk”’.

Property Value

string

Title

Short, descriptive headline. Plain text title. Multi-language string supported: ‘US:“english”;NO:“norsk”’.

Property Value

string

Updated

Last updated when

Property Value

DateTime

See Also

NewsFeedAgent, ArchiveAgent,