Safe Haskell	None
Language	Haskell2010

Simplex.Chat.Store

Synopsis

data DBStore
data StoreError
- = SEDuplicateName
- | SEUserNotFound {
  - userId :: UserId
  }
- | SEUserNotFoundByName {
  - contactName :: ContactName
  }
- | SEUserNotFoundByContactId {
  - contactId :: ContactId
  }
- | SEUserNotFoundByGroupId {
  - groupId :: GroupId
  }
- | SEUserNotFoundByFileId {
  - fileId :: FileTransferId
  }
- | SEUserNotFoundByContactRequestId {
  - contactRequestId :: Int64
  }
- | SEContactNotFound {
  - contactId :: ContactId
  }
- | SEContactNotFoundByName {
  - contactName :: ContactName
  }
- | SEContactNotFoundByMemberId {
  - groupMemberId :: GroupMemberId
  }
- | SEContactNotReady {
  - contactName :: ContactName
  }
- | SEDuplicateContactLink
- | SEUserContactLinkNotFound
- | SEContactRequestNotFound {
  - contactRequestId :: Int64
  }
- | SEContactRequestNotFoundByName {
  - contactName :: ContactName
  }
- | SEInvalidContactRequestEntity {
  - contactRequestId :: Int64
  }
- | SEInvalidBusinessChatContactRequest
- | SEGroupNotFound {
  - groupId :: GroupId
  }
- | SEGroupNotFoundByName {
  - groupName :: GroupName
  }
- | SEGroupMemberNameNotFound {
  - groupId :: GroupId
  - groupMemberName :: ContactName
  }
- | SEGroupMemberNotFound {
  - groupMemberId :: GroupMemberId
  }
- | SEGroupMemberNotFoundByIndex {
  - groupMemberIndex :: Int64
  }
- | SEMemberRelationsVectorNotFound {
  - groupMemberId :: GroupMemberId
  }
- | SEGroupHostMemberNotFound {
  - groupId :: GroupId
  }
- | SEGroupMemberNotFoundByMemberId {
  - memberId :: MemberId
  }
- | SEMemberContactGroupMemberNotFound {
  - contactId :: ContactId
  }
- | SEInvalidMemberRelationUpdate
- | SEGroupWithoutUser
- | SEDuplicateGroupMember
- | SEGroupAlreadyJoined
- | SEGroupInvitationNotFound
- | SENoteFolderAlreadyExists {
  - noteFolderId :: NoteFolderId
  }
- | SENoteFolderNotFound {
  - noteFolderId :: NoteFolderId
  }
- | SEUserNoteFolderNotFound
- | SESndFileNotFound {
  - fileId :: FileTransferId
  }
- | SESndFileInvalid {
  - fileId :: FileTransferId
  }
- | SERcvFileNotFound {
  - fileId :: FileTransferId
  }
- | SERcvFileDescrNotFound {
  - fileId :: FileTransferId
  }
- | SEFileNotFound {
  - fileId :: FileTransferId
  }
- | SERcvFileInvalid {
  - fileId :: FileTransferId
  }
- | SERcvFileInvalidDescrPart
- | SELocalFileNoTransfer {
  - fileId :: FileTransferId
  }
- | SESharedMsgIdNotFoundByFileId {
  - fileId :: FileTransferId
  }
- | SEFileIdNotFoundBySharedMsgId {
  - sharedMsgId :: SharedMsgId
  }
- | SESndFileNotFoundXFTP {
  - agentSndFileId :: AgentSndFileId
  }
- | SERcvFileNotFoundXFTP {
  - agentRcvFileId :: AgentRcvFileId
  }
- | SEConnectionNotFound {
  - agentConnId :: AgentConnId
  }
- | SEConnectionNotFoundById {
  - connId :: Int64
  }
- | SEConnectionNotFoundByMemberId {
  - groupMemberId :: GroupMemberId
  }
- | SEPendingConnectionNotFound {
  - connId :: Int64
  }
- | SEUniqueID
- | SELargeMsg
- | SEInternalError {
  - message :: String
  }
- | SEDBException {
  - message :: String
  }
- | SEDBBusyError {
  - message :: String
  }
- | SEBadChatItem {
  - itemId :: ChatItemId
  - itemTs :: Maybe ChatItemTs
  }
- | SEChatItemNotFound {
  - itemId :: ChatItemId
  }
- | SEChatItemNotFoundByText {
  - text :: Text
  }
- | SEChatItemSharedMsgIdNotFound {
  - sharedMsgId :: SharedMsgId
  }
- | SEChatItemNotFoundByFileId {
  - fileId :: FileTransferId
  }
- | SEChatItemNotFoundByContactId {
  - contactId :: ContactId
  }
- | SEChatItemNotFoundByGroupId {
  - groupId :: GroupId
  }
- | SEProfileNotFound {
  - profileId :: Int64
  }
- | SEDuplicateGroupLink {
  - groupInfo :: GroupInfo
  }
- | SEGroupLinkNotFound {
  - groupInfo :: GroupInfo
  }
- | SEHostMemberIdNotFound {
  - groupId :: Int64
  }
- | SEContactNotFoundByFileId {
  - fileId :: FileTransferId
  }
- | SENoGroupSndStatus {
  - itemId :: ChatItemId
  - groupMemberId :: GroupMemberId
  }
- | SEDuplicateGroupMessage {
  - groupId :: Int64
  - sharedMsgId :: SharedMsgId
  - authorGroupMemberId :: Maybe GroupMemberId
  - forwardedByGroupMemberId :: Maybe GroupMemberId
  }
- | SERemoteHostNotFound {
  - remoteHostId :: RemoteHostId
  }
- | SERemoteHostUnknown
- | SERemoteHostDuplicateCA
- | SERemoteCtrlNotFound {
  - remoteCtrlId :: RemoteCtrlId
  }
- | SERemoteCtrlDuplicateCA
- | SEProhibitedDeleteUser {
  - userId :: UserId
  - contactId :: ContactId
  }
- | SEOperatorNotFound {
  - serverOperatorId :: Int64
  }
- | SEUsageConditionsNotFound
- | SEInvalidQuote
- | SEInvalidMention
- | SEInvalidDeliveryTask {
  - taskId :: Int64
  }
- | SEDeliveryTaskNotFound {
  - taskId :: Int64
  }
- | SEInvalidDeliveryJob {
  - jobId :: Int64
  }
- | SEDeliveryJobNotFound {
  - jobId :: Int64
  }
- | SEWorkItemError {
  - errContext :: String
  }
data ChatLockEntity
- = CLInvitation ByteString
- | CLConnection Int64
- | CLContact ContactId
- | CLGroup GroupId
- | CLUserContact Int64
- | CLContactRequest Int64
- | CLFile Int64
data UserMsgReceiptSettings = UserMsgReceiptSettings {
- enable :: Bool
- clearOverrides :: Bool
}
data UserContactLink = UserContactLink {
- userContactLinkId :: Int64
- connLinkContact :: CreatedLinkContact
- shortLinkDataSet :: Bool
- shortLinkLargeDataSet :: BoolDef
- addressSettings :: AddressSettings
}
data GroupLinkInfo = GroupLinkInfo {
- groupId :: GroupId
- memberRole :: GroupMemberRole
}
data AddressSettings = AddressSettings {
- businessAddress :: Bool
- autoAccept :: Maybe AutoAccept
- autoReply :: Maybe MsgContent
}
data AutoAccept = AutoAccept {
- acceptIncognito :: IncognitoEnabled
}
createChatStore :: DBOpts -> MigrationConfig -> IO (Either MigrationError DBStore)
migrations :: [Migration]
withTransaction :: DBStore -> (Connection -> IO a) -> IO a

Documentation

data DBStore #

data StoreError Source #

Constructors

SEDuplicateName
SEUserNotFound
Fields userId :: UserId
SEUserNotFoundByName
Fields contactName :: ContactName
SEUserNotFoundByContactId
Fields contactId :: ContactId
SEUserNotFoundByGroupId
Fields groupId :: GroupId
SEUserNotFoundByFileId
Fields fileId :: FileTransferId
SEUserNotFoundByContactRequestId
Fields contactRequestId :: Int64
SEContactNotFound
Fields contactId :: ContactId
SEContactNotFoundByName
Fields contactName :: ContactName
SEContactNotFoundByMemberId
Fields groupMemberId :: GroupMemberId
SEContactNotReady
Fields contactName :: ContactName
SEDuplicateContactLink
SEUserContactLinkNotFound
SEContactRequestNotFound
Fields contactRequestId :: Int64
SEContactRequestNotFoundByName
Fields contactName :: ContactName
SEInvalidContactRequestEntity
Fields contactRequestId :: Int64
SEInvalidBusinessChatContactRequest
SEGroupNotFound
Fields groupId :: GroupId
SEGroupNotFoundByName
Fields groupName :: GroupName
SEGroupMemberNameNotFound
Fields groupId :: GroupId groupMemberName :: ContactName
SEGroupMemberNotFound
Fields groupMemberId :: GroupMemberId
SEGroupMemberNotFoundByIndex
Fields groupMemberIndex :: Int64
SEMemberRelationsVectorNotFound
Fields groupMemberId :: GroupMemberId
SEGroupHostMemberNotFound
Fields groupId :: GroupId
SEGroupMemberNotFoundByMemberId
Fields memberId :: MemberId
SEMemberContactGroupMemberNotFound
Fields contactId :: ContactId
SEInvalidMemberRelationUpdate
SEGroupWithoutUser
SEDuplicateGroupMember
SEGroupAlreadyJoined
SEGroupInvitationNotFound
SENoteFolderAlreadyExists
Fields noteFolderId :: NoteFolderId
SENoteFolderNotFound
Fields noteFolderId :: NoteFolderId
SEUserNoteFolderNotFound
SESndFileNotFound
Fields fileId :: FileTransferId
SESndFileInvalid
Fields fileId :: FileTransferId
SERcvFileNotFound
Fields fileId :: FileTransferId
SERcvFileDescrNotFound
Fields fileId :: FileTransferId
SEFileNotFound
Fields fileId :: FileTransferId
SERcvFileInvalid
Fields fileId :: FileTransferId
SERcvFileInvalidDescrPart
SELocalFileNoTransfer
Fields fileId :: FileTransferId
SESharedMsgIdNotFoundByFileId
Fields fileId :: FileTransferId
SEFileIdNotFoundBySharedMsgId
Fields sharedMsgId :: SharedMsgId
SESndFileNotFoundXFTP
Fields agentSndFileId :: AgentSndFileId
SERcvFileNotFoundXFTP
Fields agentRcvFileId :: AgentRcvFileId
SEConnectionNotFound
Fields agentConnId :: AgentConnId
SEConnectionNotFoundById
Fields connId :: Int64
SEConnectionNotFoundByMemberId
Fields groupMemberId :: GroupMemberId
SEPendingConnectionNotFound
Fields connId :: Int64
SEUniqueID
SELargeMsg
SEInternalError
Fields message :: String
SEDBException
Fields message :: String
SEDBBusyError
Fields message :: String
SEBadChatItem
Fields itemId :: ChatItemId itemTs :: Maybe ChatItemTs
SEChatItemNotFound
Fields itemId :: ChatItemId
SEChatItemNotFoundByText
Fields text :: Text
SEChatItemSharedMsgIdNotFound
Fields sharedMsgId :: SharedMsgId
SEChatItemNotFoundByFileId
Fields fileId :: FileTransferId
SEChatItemNotFoundByContactId
Fields contactId :: ContactId
SEChatItemNotFoundByGroupId
Fields groupId :: GroupId
SEProfileNotFound
Fields profileId :: Int64
SEDuplicateGroupLink
Fields groupInfo :: GroupInfo
SEGroupLinkNotFound
Fields groupInfo :: GroupInfo
SEHostMemberIdNotFound
Fields groupId :: Int64
SEContactNotFoundByFileId
Fields fileId :: FileTransferId
SENoGroupSndStatus
Fields itemId :: ChatItemId groupMemberId :: GroupMemberId
SEDuplicateGroupMessage
Fields groupId :: Int64 sharedMsgId :: SharedMsgId authorGroupMemberId :: Maybe GroupMemberId forwardedByGroupMemberId :: Maybe GroupMemberId
SERemoteHostNotFound
Fields remoteHostId :: RemoteHostId
SERemoteHostUnknown
SERemoteHostDuplicateCA
SERemoteCtrlNotFound
Fields remoteCtrlId :: RemoteCtrlId
SERemoteCtrlDuplicateCA
SEProhibitedDeleteUser
Fields userId :: UserId contactId :: ContactId
SEOperatorNotFound
Fields serverOperatorId :: Int64
SEUsageConditionsNotFound
SEInvalidQuote
SEInvalidMention
SEInvalidDeliveryTask
Fields taskId :: Int64
SEDeliveryTaskNotFound
Fields taskId :: Int64
SEInvalidDeliveryJob
Fields jobId :: Int64
SEDeliveryJobNotFound
Fields jobId :: Int64
SEWorkItemError	Error when reading work item that suspends worker - do not use!
Fields errContext :: String

Instances

Instances details

FromJSON StoreError Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods parseJSON :: Value -> Parser StoreError parseJSONList :: Value -> Parser [StoreError] omittedField :: Maybe StoreError
ToJSON StoreError Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods toJSON :: StoreError -> Value toEncoding :: StoreError -> Encoding toJSONList :: [StoreError] -> Value toEncodingList :: [StoreError] -> Encoding omitField :: StoreError -> Bool
Exception StoreError Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods toException :: StoreError -> SomeException fromException :: SomeException -> Maybe StoreError displayException :: StoreError -> String
Show StoreError Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods showsPrec :: Int -> StoreError -> ShowS show :: StoreError -> String showList :: [StoreError] -> ShowS
AnyStoreError StoreError Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods isWorkItemError :: StoreError -> Bool mkWorkItemError :: String -> StoreError
AnyError StoreError Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods fromSomeException :: SomeException -> StoreError

data ChatLockEntity Source #

Constructors

CLInvitation ByteString
CLConnection Int64
CLContact ContactId
CLGroup GroupId
CLUserContact Int64
CLContactRequest Int64
CLFile Int64

Instances

Instances details

Eq ChatLockEntity Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods (==) :: ChatLockEntity -> ChatLockEntity -> Bool (/=) :: ChatLockEntity -> ChatLockEntity -> Bool
Ord ChatLockEntity Source #
Instance details Defined in Simplex.Chat.Store.Shared Methods compare :: ChatLockEntity -> ChatLockEntity -> Ordering (<) :: ChatLockEntity -> ChatLockEntity -> Bool (<=) :: ChatLockEntity -> ChatLockEntity -> Bool (>) :: ChatLockEntity -> ChatLockEntity -> Bool (>=) :: ChatLockEntity -> ChatLockEntity -> Bool max :: ChatLockEntity -> ChatLockEntity -> ChatLockEntity min :: ChatLockEntity -> ChatLockEntity -> ChatLockEntity

data UserMsgReceiptSettings Source #

Constructors

UserMsgReceiptSettings
Fields enable :: Bool clearOverrides :: Bool

Instances

Instances details

Show UserMsgReceiptSettings Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods showsPrec :: Int -> UserMsgReceiptSettings -> ShowS show :: UserMsgReceiptSettings -> String showList :: [UserMsgReceiptSettings] -> ShowS

data UserContactLink Source #

Constructors

UserContactLink
Fields userContactLinkId :: Int64 connLinkContact :: CreatedLinkContact shortLinkDataSet :: Bool shortLinkLargeDataSet :: BoolDef addressSettings :: AddressSettings

Instances

Instances details

FromJSON UserContactLink Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods parseJSON :: Value -> Parser UserContactLink parseJSONList :: Value -> Parser [UserContactLink] omittedField :: Maybe UserContactLink
ToJSON UserContactLink Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods toJSON :: UserContactLink -> Value toEncoding :: UserContactLink -> Encoding toJSONList :: [UserContactLink] -> Value toEncodingList :: [UserContactLink] -> Encoding omitField :: UserContactLink -> Bool
Show UserContactLink Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods showsPrec :: Int -> UserContactLink -> ShowS show :: UserContactLink -> String showList :: [UserContactLink] -> ShowS

data GroupLinkInfo Source #

Constructors

GroupLinkInfo
Fields groupId :: GroupId memberRole :: GroupMemberRole

Instances

Instances details

Show GroupLinkInfo Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods showsPrec :: Int -> GroupLinkInfo -> ShowS show :: GroupLinkInfo -> String showList :: [GroupLinkInfo] -> ShowS

data AddressSettings Source #

Constructors

AddressSettings
Fields businessAddress :: Bool autoAccept :: Maybe AutoAccept autoReply :: Maybe MsgContent

Instances

Instances details

FromJSON AddressSettings Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods parseJSON :: Value -> Parser AddressSettings parseJSONList :: Value -> Parser [AddressSettings] omittedField :: Maybe AddressSettings
ToJSON AddressSettings Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods toJSON :: AddressSettings -> Value toEncoding :: AddressSettings -> Encoding toJSONList :: [AddressSettings] -> Value toEncodingList :: [AddressSettings] -> Encoding omitField :: AddressSettings -> Bool
Show AddressSettings Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods showsPrec :: Int -> AddressSettings -> ShowS show :: AddressSettings -> String showList :: [AddressSettings] -> ShowS
Eq AddressSettings Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods (==) :: AddressSettings -> AddressSettings -> Bool (/=) :: AddressSettings -> AddressSettings -> Bool

data AutoAccept Source #

Constructors

AutoAccept
Fields acceptIncognito :: IncognitoEnabled

Instances

Instances details

FromJSON AutoAccept Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods parseJSON :: Value -> Parser AutoAccept parseJSONList :: Value -> Parser [AutoAccept] omittedField :: Maybe AutoAccept
ToJSON AutoAccept Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods toJSON :: AutoAccept -> Value toEncoding :: AutoAccept -> Encoding toJSONList :: [AutoAccept] -> Value toEncodingList :: [AutoAccept] -> Encoding omitField :: AutoAccept -> Bool
Show AutoAccept Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods showsPrec :: Int -> AutoAccept -> ShowS show :: AutoAccept -> String showList :: [AutoAccept] -> ShowS
Eq AutoAccept Source #
Instance details Defined in Simplex.Chat.Store.Profiles Methods (==) :: AutoAccept -> AutoAccept -> Bool (/=) :: AutoAccept -> AutoAccept -> Bool

createChatStore :: DBOpts -> MigrationConfig -> IO (Either MigrationError DBStore) Source #

migrations :: [Migration] Source #

The list of migrations in ascending order by date

withTransaction :: DBStore -> (Connection -> IO a) -> IO a #