Interface IInternalMessagingController
  
  
  
  Assembly: DotNetNuke.dll
  Syntax
  
    public interface IInternalMessagingController
   
  Methods
  
  AttachmentsAllowed(int)
  
  
  Declaration
  
    bool AttachmentsAllowed(int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
    
  
  Returns
  
  
  CheckReplyHasRecipients(int, int)
  
  
  Declaration
  
    int CheckReplyHasRecipients(int conversationId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
    
  
  Returns
  
  
  ConvertLegacyMessages(int, int)
  
  
  Declaration
  
    void ConvertLegacyMessages(int pageIndex, int pageSize)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | pageIndex |  | 
      
        | int | pageSize |  | 
    
  
  
  CountArchivedConversations(int, int)
  
  
  Declaration
  
    int CountArchivedConversations(int userId, int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | portalId |  | 
    
  
  Returns
  
  
  CountArchivedMessages(int, int)
  
  
  Declaration
  
    int CountArchivedMessages(int userId, int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | portalId |  | 
    
  
  Returns
  
  
  CountArchivedMessagesByConversation(int)
  
  
  Declaration
  
    int CountArchivedMessagesByConversation(int conversationId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
    
  
  Returns
  
  
  CountConversations(int, int)
  
  
  Declaration
  
    int CountConversations(int userId, int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | portalId |  | 
    
  
  Returns
  
  
  CountLegacyMessages()
  
  
  Declaration
  
    int CountLegacyMessages()
   
  Returns
  
  
  CountMessagesByConversation(int)
  
  
  Declaration
  
    int CountMessagesByConversation(int conversationId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
    
  
  Returns
  
  
  CountSentConversations(int, int)
  
  
  Declaration
  
    int CountSentConversations(int userId, int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | portalId |  | 
    
  
  Returns
  
  
  CountSentMessages(int, int)
  
  
  Declaration
  
    int CountSentMessages(int userId, int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | portalId |  | 
    
  
  Returns
  
  
  CountUnreadMessages(int, int)
  
  
  Declaration
  
    int CountUnreadMessages(int userId, int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | portalId |  | 
    
  
  Returns
  
  
  DeleteMessageRecipient(int, int)
  
  
  Declaration
  
    void DeleteMessageRecipient(int messageId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
      
        | int | userId |  | 
    
  
  
  DeleteUserFromConversation(int, int)
  
  
  Declaration
  
    void DeleteUserFromConversation(int conversationId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
    
  
  
  DisablePrivateMessage(int)
  
  
  Declaration
  
    bool DisablePrivateMessage(int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
    
  
  Returns
  
  
  GetArchivedMessages(int, int, int)
  
  
  Declaration
  
    MessageBoxView GetArchivedMessages(int userId, int afterMessageId, int numberOfRecords)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
    
  
  Returns
  
  
  GetAttachments(int)
  
  
  Declaration
  
    IEnumerable<MessageFileView> GetAttachments(int messageId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
    
  
  Returns
  
  
  GetInbox(int, int, int, string, bool)
  
  
  Declaration
  
    MessageBoxView GetInbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool sortAscending)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
      
        | string | sortColumn |  | 
      
        | bool | sortAscending |  | 
    
  
  Returns
  
  
  GetInbox(int, int, int, string, bool, MessageReadStatus, MessageArchivedStatus)
  
  
  Declaration
  
    MessageBoxView GetInbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool ascending, MessageReadStatus readStatus, MessageArchivedStatus archivedStatus)
   
  Parameters
  
  Returns
  
  
  GetLastSentMessage(UserInfo)
  
  
  Declaration
  
    Message GetLastSentMessage(UserInfo sender)
   
  Parameters
  
  Returns
  
  
  GetMessage(int)
  
  
  Declaration
  
    Message GetMessage(int messageId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
    
  
  Returns
  
  
  GetMessageRecipient(int, int)
  
  
  Declaration
  
    MessageRecipient GetMessageRecipient(int messageId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
      
        | int | userId |  | 
    
  
  Returns
  
  
  GetMessageRecipients(int)
  
  
  Declaration
  
    IList<MessageRecipient> GetMessageRecipients(int messageId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
    
  
  Returns
  
  
  GetMessageThread(int, int, int, int, ref int)
  
  
  Declaration
  
    MessageThreadsView GetMessageThread(int conversationId, int userId, int afterMessageId, int numberOfRecords, ref int totalRecords)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
      
        | int | totalRecords |  | 
    
  
  Returns
  
  
  GetMessageThread(int, int, int, int, string, bool, ref int)
  
  
  Declaration
  
    MessageThreadsView GetMessageThread(int conversationId, int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool ascending, ref int totalRecords)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
      
        | string | sortColumn |  | 
      
        | bool | ascending |  | 
      
        | int | totalRecords |  | 
    
  
  Returns
  
  
  GetNextMessagesForDigestDispatch(Frequency, Guid, int)
  
  
  Declaration
  
    IList<MessageRecipient> GetNextMessagesForDigestDispatch(Frequency frequency, Guid schedulerInstance, int batchSize)
   
  Parameters
  
  Returns
  
  
  GetNextMessagesForInstantDispatch(Guid, int)
  
  
  Declaration
  
    IList<MessageRecipient> GetNextMessagesForInstantDispatch(Guid schedulerInstance, int batchSize)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Guid | schedulerInstance |  | 
      
        | int | batchSize |  | 
    
  
  Returns
  
  
  GetRecentInbox(int)
  
  
  Declaration
  
    MessageBoxView GetRecentInbox(int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
    
  
  Returns
  
  
  GetRecentInbox(int, int, int)
  
  
  Declaration
  
    MessageBoxView GetRecentInbox(int userId, int afterMessageId, int numberOfRecords)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
    
  
  Returns
  
  
  GetRecentSentbox(int)
  
  
  Declaration
  
    MessageBoxView GetRecentSentbox(int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
    
  
  Returns
  
  
  GetRecentSentbox(int, int, int)
  
  
  Declaration
  
    MessageBoxView GetRecentSentbox(int userId, int afterMessageId, int numberOfRecords)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
    
  
  Returns
  
  
  GetSentbox(int, int, int, string, bool)
  
  
  Declaration
  
    MessageBoxView GetSentbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool sortAscending)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | userId |  | 
      
        | int | afterMessageId |  | 
      
        | int | numberOfRecords |  | 
      
        | string | sortColumn |  | 
      
        | bool | sortAscending |  | 
    
  
  Returns
  
  
  GetSentbox(int, int, int, string, bool, MessageReadStatus, MessageArchivedStatus)
  
  
  Declaration
  
    MessageBoxView GetSentbox(int userId, int afterMessageId, int numberOfRecords, string sortColumn, bool ascending, MessageReadStatus readStatus, MessageArchivedStatus archivedStatus)
   
  Parameters
  
  Returns
  
  
  IncludeAttachments(int)
  
  
  Declaration
  
    bool IncludeAttachments(int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
    
  
  Returns
  
  
  MarkArchived(int, int)
  
  
  Declaration
  
    void MarkArchived(int conversationId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
    
  
  
  MarkMessageAsDispatched(int, int)
  
  
  Declaration
  
    void MarkMessageAsDispatched(int messageId, int recipientId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
      
        | int | recipientId |  | 
    
  
  
  MarkMessageAsSent(int, int)
  
  
  Declaration
  
    void MarkMessageAsSent(int messageId, int recipientId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | messageId |  | 
      
        | int | recipientId |  | 
    
  
  
  MarkRead(int, int)
  
  
  Declaration
  
    void MarkRead(int conversationId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
    
  
  
  MarkUnArchived(int, int)
  
  
  Declaration
  
    void MarkUnArchived(int conversationId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
    
  
  
  MarkUnRead(int, int)
  
  
  Declaration
  
    void MarkUnRead(int conversationId, int userId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | conversationId |  | 
      
        | int | userId |  | 
    
  
  
  RecipientLimit(int)
  
  
  Declaration
  
    int RecipientLimit(int portalId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | int | portalId |  | 
    
  
  Returns
  
  
  ReplyMessage(int, string, IList<int>)
  
  
  Declaration
  
    int ReplyMessage(int conversationId, string body, IList<int> fileIDs)
   
  Parameters
  
  Returns
  
  
  ReplyMessage(int, string, IList<int>, UserInfo)
  
  
  Declaration
  
    int ReplyMessage(int conversationId, string body, IList<int> fileIDs, UserInfo sender)
   
  Parameters
  
  Returns
  
  
  WaitTimeForNextMessage(UserInfo)
  
  
  Declaration
  
    int WaitTimeForNextMessage(UserInfo sender)
   
  Parameters
  
  Returns
  
  Extension Methods