Interface IInternalMessagingController

Interface used for Message Controller behaviors.

Namespace: DotNetNuke.Services.Social.Messaging.Internal
Assembly: DotNetNuke.dll
Syntax
public interface IInternalMessagingController

Methods

| Improve this Doc View Source

AttachmentsAllowed(Int32)

Are attachments allowed.

Declaration
bool AttachmentsAllowed(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
Returns
Type Description
System.Boolean

True or False.
| Improve this Doc View Source

CheckReplyHasRecipients(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CheckReplyHasRecipients(int conversationId, int userId)
Parameters
Type Name Description
System.Int32 conversationId
System.Int32 userId
Returns
Type Description
System.Int32
| Improve this Doc View Source

ConvertLegacyMessages(Int32, Int32)

Converts the legacy messages.

Declaration
void ConvertLegacyMessages(int pageIndex, int pageSize)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page.
System.Int32 pageSize

Size of the page.
| Improve this Doc View Source

CountArchivedConversations(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CountArchivedConversations(int userId, int portalId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 portalId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountArchivedMessages(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CountArchivedMessages(int userId, int portalId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 portalId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountArchivedMessagesByConversation(Int32)

Interface used for Message Controller behaviors.

Declaration
int CountArchivedMessagesByConversation(int conversationId)
Parameters
Type Name Description
System.Int32 conversationId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountConversations(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CountConversations(int userId, int portalId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 portalId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountLegacyMessages()

Counts the legacy messages.

Declaration
int CountLegacyMessages()
Returns
Type Description
System.Int32

A count of messages.
| Improve this Doc View Source

CountMessagesByConversation(Int32)

Interface used for Message Controller behaviors.

Declaration
int CountMessagesByConversation(int conversationId)
Parameters
Type Name Description
System.Int32 conversationId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountSentConversations(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CountSentConversations(int userId, int portalId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 portalId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountSentMessages(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CountSentMessages(int userId, int portalId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 portalId
Returns
Type Description
System.Int32
| Improve this Doc View Source

CountUnreadMessages(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
int CountUnreadMessages(int userId, int portalId)
Parameters
Type Name Description
System.Int32 userId
System.Int32 portalId
Returns
Type Description
System.Int32
| Improve this Doc View Source

DeleteMessageRecipient(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void DeleteMessageRecipient(int messageId, int userId)
Parameters
Type Name Description
System.Int32 messageId
System.Int32 userId
| Improve this Doc View Source

DeleteUserFromConversation(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void DeleteUserFromConversation(int conversationId, int userId)
Parameters
Type Name Description
System.Int32 conversationId
System.Int32 userId
| Improve this Doc View Source

DisablePrivateMessage(Int32)

Whether disable regular users to send message to user/group, default is false.

Declaration
bool DisablePrivateMessage(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
Returns
Type Description
System.Boolean

true if the private messages are disabled in the given portal, otherwise false.
| Improve this Doc View Source

GetArchivedMessages(Int32, Int32, Int32)

Gets the archived messages.

Declaration
MessageBoxView GetArchivedMessages(int userId, int afterMessageId, int numberOfRecords)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetAttachments(Int32)

Gets the attachments for the specified message.

Declaration
IEnumerable<MessageFileView> GetAttachments(int messageId)
Parameters
Type Name Description
System.Int32 messageId

The message identifier.
Returns
Type Description
IEnumerable<MessageFileView>

A list of MessageFileView.
| Improve this Doc View Source

GetInbox(Int32, Int32, Int32, String, Boolean, MessageReadStatus, MessageArchivedStatus)

Gets the inbox.

Declaration
MessageBoxView GetInbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool ascending, MessageReadStatus readStatus, MessageArchivedStatus archivedStatus)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
System.String sortColumn

The sort column.
System.Boolean ascending

if set to true [ascending].
MessageReadStatus readStatus

The read status.
MessageArchivedStatus archivedStatus

The archived status.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetInbox(Int32, Int32, Int32, String, Boolean)

Gets the inbox.

Declaration
MessageBoxView GetInbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool sortAscending)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
System.String sortColumn

The sort column.
System.Boolean sortAscending

if set to true [sort ascending].
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetLastSentMessage(UserInfo)

Last message sent by the User.

Declaration
Message GetLastSentMessage(UserInfo sender)
Parameters
Type Name Description
UserInfo sender

Sender's UserInfo.
Returns
Type Description
Message

Message. Null when no message was sent.
| Improve this Doc View Source

GetMessage(Int32)

Interface used for Message Controller behaviors.

Declaration
Message GetMessage(int messageId)
Parameters
Type Name Description
System.Int32 messageId
Returns
Type Description
Message
| Improve this Doc View Source

GetMessageRecipient(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
MessageRecipient GetMessageRecipient(int messageId, int userId)
Parameters
Type Name Description
System.Int32 messageId
System.Int32 userId
Returns
Type Description
MessageRecipient
| Improve this Doc View Source

GetMessageRecipients(Int32)

Interface used for Message Controller behaviors.

Declaration
IList<MessageRecipient> GetMessageRecipients(int messageId)
Parameters
Type Name Description
System.Int32 messageId
Returns
Type Description
IList<MessageRecipient>
| Improve this Doc View Source

GetMessageThread(Int32, Int32, Int32, Int32, ref Int32)

Gets the message thread.

Declaration
MessageThreadsView GetMessageThread(int conversationId, int userId, int afterMessageId, int numberOfRecords, ref int totalRecords)
Parameters
Type Name Description
System.Int32 conversationId

The conversation identifier.
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
System.Int32 totalRecords

The total records.
Returns
Type Description
MessageThreadsView

A MessageThreadsView.
| Improve this Doc View Source

GetMessageThread(Int32, Int32, Int32, Int32, String, Boolean, ref Int32)

Gets the message thread.

Declaration
MessageThreadsView GetMessageThread(int conversationId, int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool ascending, ref int totalRecords)
Parameters
Type Name Description
System.Int32 conversationId

The conversation identifier.
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
System.String sortColumn

The sort column.
System.Boolean ascending

if set to true [ascending].
System.Int32 totalRecords

The total records.
Returns
Type Description
MessageThreadsView

A MessageThreadsView.
| Improve this Doc View Source

GetNextMessagesForDigestDispatch(Frequency, Guid, Int32)

Interface used for Message Controller behaviors.

Declaration
IList<MessageRecipient> GetNextMessagesForDigestDispatch(Frequency frequency, Guid schedulerInstance, int batchSize)
Parameters
Type Name Description
Frequency frequency
Guid schedulerInstance
System.Int32 batchSize
Returns
Type Description
IList<MessageRecipient>
| Improve this Doc View Source

GetNextMessagesForInstantDispatch(Guid, Int32)

Interface used for Message Controller behaviors.

Declaration
IList<MessageRecipient> GetNextMessagesForInstantDispatch(Guid schedulerInstance, int batchSize)
Parameters
Type Name Description
Guid schedulerInstance
System.Int32 batchSize
Returns
Type Description
IList<MessageRecipient>
| Improve this Doc View Source

GetRecentInbox(Int32, Int32, Int32)

Gets the recent inbox.

Declaration
MessageBoxView GetRecentInbox(int userId, int afterMessageId, int numberOfRecords)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetRecentInbox(Int32)

Gets the recent inbox.

Declaration
MessageBoxView GetRecentInbox(int userId)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetRecentSentbox(Int32, Int32, Int32)

Gets the recent sent box.

Declaration
MessageBoxView GetRecentSentbox(int userId, int afterMessageId, int numberOfRecords)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetRecentSentbox(Int32)

Gets the recent sent box.

Declaration
MessageBoxView GetRecentSentbox(int userId)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetSentbox(Int32, Int32, Int32, String, Boolean, MessageReadStatus, MessageArchivedStatus)

Gets the sent box.

Declaration
MessageBoxView GetSentbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool ascending, MessageReadStatus readStatus, MessageArchivedStatus archivedStatus)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
System.String sortColumn

The sort column.
System.Boolean ascending

if set to true [ascending].
MessageReadStatus readStatus

The read status.
MessageArchivedStatus archivedStatus

The archived status.
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

GetSentbox(Int32, Int32, Int32, String, Boolean)

Gets the sent box.

Declaration
MessageBoxView GetSentbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool sortAscending)
Parameters
Type Name Description
System.Int32 userId

The user identifier.
System.Int32 afterMessageId

The after message identifier.
System.Int32 numberOfRecords

The number of records.
System.String sortColumn

The sort column.
System.Boolean sortAscending

if set to true [sort ascending].
Returns
Type Description
MessageBoxView

A MessageBoxView.
| Improve this Doc View Source

IncludeAttachments(Int32)

Whether or not to includes the attachment in the email message.

Declaration
bool IncludeAttachments(int portalId)
Parameters
Type Name Description
System.Int32 portalId

The portal identifier.
Returns
Type Description
System.Boolean

true if attachments are configured to be included for the given portal, otherwise false.
| Improve this Doc View Source

MarkArchived(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void MarkArchived(int conversationId, int userId)
Parameters
Type Name Description
System.Int32 conversationId
System.Int32 userId
| Improve this Doc View Source

MarkMessageAsDispatched(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void MarkMessageAsDispatched(int messageId, int recipientId)
Parameters
Type Name Description
System.Int32 messageId
System.Int32 recipientId
| Improve this Doc View Source

MarkMessageAsSent(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void MarkMessageAsSent(int messageId, int recipientId)
Parameters
Type Name Description
System.Int32 messageId
System.Int32 recipientId
| Improve this Doc View Source

MarkRead(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void MarkRead(int conversationId, int userId)
Parameters
Type Name Description
System.Int32 conversationId
System.Int32 userId
| Improve this Doc View Source

MarkUnArchived(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void MarkUnArchived(int conversationId, int userId)
Parameters
Type Name Description
System.Int32 conversationId
System.Int32 userId
| Improve this Doc View Source

MarkUnRead(Int32, Int32)

Interface used for Message Controller behaviors.

Declaration
void MarkUnRead(int conversationId, int userId)
Parameters
Type Name Description
System.Int32 conversationId
System.Int32 userId
| Improve this Doc View Source

RecipientLimit(Int32)

Maximum number of Recipients allowed.

Declaration
int RecipientLimit(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id.
Returns
Type Description
System.Int32

Count. Message to a Role is considered a single Recipient. Each User in the To list is counted as one User each.
| Improve this Doc View Source

ReplyMessage(Int32, String, IList<Int32>, UserInfo)

Interface used for Message Controller behaviors.

Declaration
int ReplyMessage(int conversationId, string body, IList<int> fileIDs, UserInfo sender)
Parameters
Type Name Description
System.Int32 conversationId
System.String body
IList<System.Int32> fileIDs
UserInfo sender
Returns
Type Description
System.Int32
| Improve this Doc View Source

ReplyMessage(Int32, String, IList<Int32>)

Interface used for Message Controller behaviors.

Declaration
int ReplyMessage(int conversationId, string body, IList<int> fileIDs)
Parameters
Type Name Description
System.Int32 conversationId
System.String body
IList<System.Int32> fileIDs
Returns
Type Description
System.Int32
| Improve this Doc View Source

WaitTimeForNextMessage(UserInfo)

How long a user needs to wait before user is allowed sending the next message.

Declaration
int WaitTimeForNextMessage(UserInfo sender)
Parameters
Type Name Description
UserInfo sender

Sender's UserInfo.
Returns
Type Description
System.Int32

Time in seconds. Returns zero if user has never sent a message.

Extension Methods