Class NewsFeedItem

News feed items are created by agents or other services for display on the start page and other relevant places in the UI.

Carrier object for NewsFeedItem. Services for the NewsFeedItem Carrier is available from the NewsFeed Agent.

Inheritance

object

NewsFeedItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/12.2.0.0")]
public class NewsFeedItem

Examples

Get NewsFeedItem 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new NewsFeedAgent();
   var newsFeedItem = agent.GetNewsFeedItem( 123 );
}

Find all NewsFeedItem, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("NewsFeedItem", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

NewsFeedItem()

Default constructor

Declaration

public NewsFeedItem()

See Also

INewsFeedAgent

Properties

Actions

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

Declaration

[DataMember]
public virtual NewsFeedCTA[] Actions { get; set; }

Property Value

Type	Description
NewsFeedCTA[]

See Also

INewsFeedAgent

ApplicationId

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

Declaration

[DataMember]
public virtual string ApplicationId { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

Contact

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

Declaration

[DataMember]
public virtual Contact Contact { get; set; }

Property Value

Type	Description
Contact

See Also

INewsFeedAgent

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.

Declaration

[DataMember]
public virtual StringDictionary Description { get; set; }

Property Value

Type	Description
StringDictionary

See Also

INewsFeedAgent

ExpiresAt

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

Declaration

[DataMember]
public virtual DateTime ExpiresAt { get; set; }

Property Value

Type	Description
DateTime

See Also

INewsFeedAgent

FromCategoryName

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

Declaration

[DataMember]
public virtual string FromCategoryName { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

FromName

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

Declaration

[DataMember]
public virtual string FromName { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

ImageLink

URL Link to an image associated with the news item.

Declaration

[DataMember]
public virtual string ImageLink { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

IsRead

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

Declaration

[DataMember]
public virtual bool IsRead { get; set; }

Property Value

Type	Description
bool

See Also

INewsFeedAgent

NewsFeedItemId

Primary key

Declaration

[DataMember]
public virtual int NewsFeedItemId { get; set; }

Property Value

Type	Description
int

See Also

INewsFeedAgent

Person

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

Declaration

[DataMember]
public virtual Person Person { get; set; }

Property Value

Type	Description
Person

See Also

INewsFeedAgent

PreviewHint

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

Declaration

[DataMember]
public virtual string PreviewHint { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

Priority

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

Declaration

[DataMember]
public virtual EMailPriority Priority { get; set; }

Property Value

Type	Description
EMailPriority

See Also

INewsFeedAgent

Project

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

Declaration

[DataMember]
public virtual Project Project { get; set; }

Property Value

Type	Description
Project

See Also

INewsFeedAgent

ReadAt

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

Declaration

[DataMember]
public virtual DateTime ReadAt { get; set; }

Property Value

Type	Description
DateTime

See Also

INewsFeedAgent

Registered

Registered when in UTC.

Declaration

[DataMember]
public virtual DateTime Registered { get; set; }

Property Value

Type	Description
DateTime

See Also

INewsFeedAgent

Sale

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

Declaration

[DataMember]
public virtual Sale Sale { get; set; }

Property Value

Type	Description
Sale

See Also

INewsFeedAgent

SourceLink

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

Declaration

[DataMember]
public virtual string SourceLink { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

Status

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

Declaration

[DataMember]
public virtual NewsFeedItemStatus Status { get; set; }

Property Value

Type	Description
NewsFeedItemStatus

See Also

INewsFeedAgent

Summary

Short, descriptive summary. Plain text summary. Multi-language string supported: 'US:"english";NO:"norsk"'.

Declaration

[DataMember]
public virtual string Summary { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

Title

Short, descriptive headline. Plain text title. Multi-language string supported: 'US:"english";NO:"norsk"'.

Declaration

[DataMember]
public virtual string Title { get; set; }

Property Value

Type	Description
string

See Also

INewsFeedAgent

Updated

Last updated when in UTC.

Declaration

[DataMember]
public virtual DateTime Updated { get; set; }

Property Value

Type	Description
DateTime

See Also

INewsFeedAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
string	The carrier contents.

Overrides

object.ToString()

See Also

INewsFeedAgent

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.

See Also

INewsFeedAgent

See Also

INewsFeedAgent