Skip to main content

Interface IMentionAgent

Namespace: SuperOffice.WebApi.Agents Assembly: SuperOffice.WebApi.dll Agent used for getting, marking read, and deleting @-mentions

Implements

IAgentBase, IDisposable

Methods

DeleteMentionsAsync(int[], RequestOptions)

Delete mentions by id

Parameters

mentionIds int[] Ids of mention rows to delete requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

GetMentionsCreatedByMeAsync(RequestOptions)

Get the @-mentions the current associate created (tagged someone else)

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Mention[]&gt; The current associate’s created mentions, most-recent-first

GetMyMentionsAsync(bool, RequestOptions)

Get the current associate’s @-mentions

Parameters

unreadOnly bool When true, only unread mentions are returned requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<Mention[]&gt; The current associate’s mentions, most-recent-first

GetMyMentionsUnreadCountAsync(RequestOptions)

Get the current associate’s unread @-mention count

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<int&gt; The current associate’s unread mention count

MarkMentionsAsReadAsync(int[], RequestOptions)

Mark mentions as read

Parameters

mentionIds int[] Ids of the mentions to mark read requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value

UpdateMentionSnippetsAsync(int, int[], RequestOptions)

Insert-missing and refresh-existing mention rows for a saved message

Parameters

messageId int The message the mentions belong to mentionedAssociateIds int[] The colleagues mentioned in the message’s current content requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task This method has no return value