| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
Wire.API.Federation.API.Galley
Synopsis
- type GalleyApi = FedEndpoint "on-conversation-created" (ConversationCreated ConvId) EmptyResponse :<|> (Named "get-conversations@v1" (UnnamedFedEndpointWithMods '[Until 'V2] "get-conversations" GetConversationsRequest GetConversationsResponse) :<|> (FedEndpointWithMods '[From 'V2] "get-conversations" GetConversationsRequest GetConversationsResponseV2 :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "on-conversation-updated", MakesFederatedCall 'Galley "on-mls-message-sent", MakesFederatedCall 'Brig "get-users-by-ids", MakesFederatedCall 'Brig "api-version"] "leave-conversation" LeaveConversationRequest LeaveConversationResponse :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "on-message-sent", MakesFederatedCall 'Brig "get-user-clients"] "send-message" ProteusMessageSendRequest MessageSendResponse :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "on-conversation-updated", MakesFederatedCall 'Galley "on-mls-message-sent", MakesFederatedCall 'Brig "get-users-by-ids", MakesFederatedCall 'Galley "on-mls-message-sent"] "update-conversation" ConversationUpdateRequest ConversationUpdateResponse :<|> (FedEndpoint "mls-welcome" MLSWelcomeRequest MLSWelcomeResponse :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "on-conversation-updated", MakesFederatedCall 'Galley "on-mls-message-sent", MakesFederatedCall 'Galley "send-mls-message", MakesFederatedCall 'Brig "get-mls-clients"] "send-mls-message" MLSMessageSendRequest MLSMessageResponse :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "mls-welcome", MakesFederatedCall 'Galley "on-conversation-updated", MakesFederatedCall 'Galley "on-mls-message-sent", MakesFederatedCall 'Galley "send-mls-commit-bundle", MakesFederatedCall 'Brig "get-mls-clients", MakesFederatedCall 'Brig "get-users-by-ids", MakesFederatedCall 'Brig "api-version"] "send-mls-commit-bundle" MLSMessageSendRequest MLSMessageResponse :<|> (FedEndpoint "query-group-info" GetGroupInfoRequest GetGroupInfoResponse :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "on-typing-indicator-updated"] "update-typing-indicator" TypingDataUpdateRequest TypingDataUpdateResponse :<|> (FedEndpoint "on-typing-indicator-updated" TypingDataUpdated EmptyResponse :<|> (FedEndpointWithMods '[From 'V1] "get-sub-conversation" GetSubConversationsRequest GetSubConversationsResponse :<|> (FedEndpointWithMods '[From 'V1] "delete-sub-conversation" DeleteSubConversationFedRequest DeleteSubConversationResponse :<|> (FedEndpointWithMods '[MakesFederatedCall 'Galley "on-mls-message-sent", From 'V1] "leave-sub-conversation" LeaveSubConversationRequest LeaveSubConversationResponse :<|> (Named "get-one2one-conversation@v1" (UnnamedFedEndpointWithMods '[From 'V1, Until 'V2] "get-one2one-conversation" GetOne2OneConversationRequest GetOne2OneConversationResponse) :<|> (FedEndpointWithMods '[From 'V2] "get-one2one-conversation" GetOne2OneConversationRequest GetOne2OneConversationResponseV2 :<|> GalleyNotificationAPI))))))))))))))))
- data ConversationCreated conv = ConversationCreated {
- time :: UTCTime
- origUserId :: UserId
- cnvId :: conv
- cnvType :: ConvType
- cnvAccess :: [Access]
- cnvAccessRoles :: Set AccessRole
- cnvName :: Maybe Text
- nonCreatorMembers :: Set OtherMember
- messageTimer :: Maybe Milliseconds
- receiptMode :: Maybe ReceiptMode
- protocol :: Protocol
- data GetConversationsRequest = GetConversationsRequest {}
- newtype GetConversationsResponse = GetConversationsResponse {
- convs :: [RemoteConversation]
- newtype GetConversationsResponseV2 = GetConversationsResponseV2 {}
- data LeaveConversationRequest = LeaveConversationRequest {}
- newtype LeaveConversationResponse = LeaveConversationResponse {}
- data ProteusMessageSendRequest = ProteusMessageSendRequest {}
- newtype MessageSendResponse = MessageSendResponse {}
- data ConversationUpdateRequest = ConversationUpdateRequest {}
- data ConversationUpdateResponse
- data MLSWelcomeRequest = MLSWelcomeRequest {}
- data MLSWelcomeResponse
- data MLSMessageSendRequest = MLSMessageSendRequest {}
- data MLSMessageResponse
- data GetGroupInfoRequest = GetGroupInfoRequest {
- conv :: ConvOrSubConvId
- sender :: UserId
- data GetGroupInfoResponse
- data TypingDataUpdateRequest = TypingDataUpdateRequest {
- typingStatus :: TypingStatus
- userId :: UserId
- convId :: ConvId
- data TypingDataUpdateResponse
- data TypingDataUpdated = TypingDataUpdated {
- time :: UTCTime
- origUserId :: Qualified UserId
- convId :: ConvId
- usersInConv :: [UserId]
- typingStatus :: TypingStatus
- data GetSubConversationsRequest = GetSubConversationsRequest {}
- data GetSubConversationsResponse
- data DeleteSubConversationFedRequest = DeleteSubConversationFedRequest {}
- data DeleteSubConversationResponse
- data LeaveSubConversationRequest = LeaveSubConversationRequest {}
- data LeaveSubConversationResponse
- data GetOne2OneConversationRequest = GetOne2OneConversationRequest {}
- data GetOne2OneConversationResponse
- data GetOne2OneConversationResponseV2
- data RemoteConvMembers = RemoteConvMembers {
- selfRole :: RoleName
- others :: [OtherMember]
- data RemoteConversation = RemoteConversation {}
- data RemoteConversationV2 = RemoteConversationV2 {}
- data RemoteMLSOne2OneConversation = RemoteMLSOne2OneConversation {}
- data RemoveFromConversationError
- data RemoteMLSMessageResponse
- swaggerDoc :: OpenApi
- remoteConversationFromV2 :: RemoteConversationV2 -> RemoteConversation
- remoteConversationToV2 :: RemoteConversation -> RemoteConversationV2
- getConversationsResponseToV2 :: GetConversationsResponse -> GetConversationsResponseV2
- getConversationsResponseFromV2 :: GetConversationsResponseV2 -> GetConversationsResponse
- ccRemoteOrigUserId :: ConversationCreated (Remote ConvId) -> Remote UserId
- module Wire.API.Federation.API.Galley.Notifications
Documentation
Arguments
For conventions see docsdeveloper/federation-api-conventions.md
data ConversationCreated conv Source #
A record type describing a new federated conversation
FUTUREWORK: Think about extracting common conversation metadata into a separarate data type that can be reused in several data types in this module.
Constructors
| ConversationCreated | |
Fields
| |
Instances
data GetConversationsRequest Source #
Constructors
| GetConversationsRequest | |
Instances
newtype GetConversationsResponse Source #
Constructors
| GetConversationsResponse | |
Fields
| |
Instances
newtype GetConversationsResponseV2 Source #
Constructors
| GetConversationsResponseV2 | |
Fields | |
Instances
data LeaveConversationRequest Source #
Constructors
| LeaveConversationRequest | |
Instances
newtype LeaveConversationResponse Source #
Constructors
| LeaveConversationResponse | |
Fields | |
Instances
data ProteusMessageSendRequest Source #
Constructors
| ProteusMessageSendRequest | |
Fields
| |
Instances
newtype MessageSendResponse Source #
Constructors
| MessageSendResponse | |
Fields | |
Instances
data ConversationUpdateRequest Source #
Constructors
| ConversationUpdateRequest | |
Instances
data ConversationUpdateResponse Source #
Constructors
Instances
data MLSWelcomeRequest Source #
A wrapper around a raw welcome message
Constructors
| MLSWelcomeRequest | |
Fields
| |
Instances
data MLSWelcomeResponse Source #
Constructors
| MLSWelcomeSent | |
| MLSWelcomeMLSNotEnabled |
Instances
data MLSMessageSendRequest Source #
Constructors
| MLSMessageSendRequest | |
Fields
| |
Instances
data MLSMessageResponse Source #
Constructors
| MLSMessageResponseError GalleyError | |
| MLSMessageResponseProtocolError Text | |
| MLSMessageResponseProposalFailure JSONResponse | |
| MLSMessageResponseUnreachableBackends (Set Domain) | The conversation-owning backend could not reach some of the backends that have users in the conversation when processing a commit. |
| MLSMessageResponseUpdates [ConversationUpdate] | If the list of unreachable users is non-empty, it corresponds to users that an application message could not be sent to. |
| MLSMessageResponseNonFederatingBackends NonFederatingBackends |
Instances
data GetGroupInfoRequest Source #
Constructors
| GetGroupInfoRequest | |
Fields
| |
Instances
data GetGroupInfoResponse Source #
Instances
data TypingDataUpdateRequest Source #
Constructors
| TypingDataUpdateRequest | |
Fields
| |
Instances
data TypingDataUpdateResponse Source #
Instances
data TypingDataUpdated Source #
Constructors
| TypingDataUpdated | |
Fields
| |
Instances
data GetSubConversationsRequest Source #
Constructors
| GetSubConversationsRequest | |
Instances
data GetSubConversationsResponse Source #
Constructors
| GetSubConversationsResponseError GalleyError | |
| GetSubConversationsResponseSuccess PublicSubConversation |
Instances
data DeleteSubConversationFedRequest Source #
Constructors
| DeleteSubConversationFedRequest | |
Fields
| |
Instances
data DeleteSubConversationResponse Source #
Instances
data LeaveSubConversationRequest Source #
Constructors
| LeaveSubConversationRequest | |
Fields
| |
Instances
data LeaveSubConversationResponse Source #
Constructors
| LeaveSubConversationResponseError GalleyError | |
| LeaveSubConversationResponseProtocolError Text | |
| LeaveSubConversationResponseOk |
Instances
data GetOne2OneConversationRequest Source #
Constructors
| GetOne2OneConversationRequest | |
Fields | |
Instances
data GetOne2OneConversationResponse Source #
Constructors
| GetOne2OneConversationOk RemoteConversation | |
| GetOne2OneConversationBackendMismatch | This is returned when the local backend is asked for a 1-1 conversation that should reside on the other backend. |
| GetOne2OneConversationNotConnected | This is returned when a 1-1 conversation between two unconnected users is requested. |
Instances
data GetOne2OneConversationResponseV2 Source #
Constructors
| GetOne2OneConversationV2Ok RemoteMLSOne2OneConversation | |
| GetOne2OneConversationV2BackendMismatch | This is returned when the local backend is asked for a 1-1 conversation that should reside on the other backend. |
| GetOne2OneConversationV2NotConnected | This is returned when a 1-1 conversation between two unconnected users is requested. |
| GetOne2OneConversationV2MLSNotEnabled |
Instances
data RemoteConvMembers Source #
Constructors
| RemoteConvMembers | |
Fields
| |
Instances
data RemoteConversation Source #
A conversation hosted on a remote backend. This contains the same
information as a Conversation, with the exception that conversation status
fields (muted/archived/hidden) are omitted, since they are not known by the
remote backend.
Constructors
| RemoteConversation | |
Fields
| |
Instances
data RemoteConversationV2 Source #
A conversation hosted on a remote backend. This contains the same
information as a Conversation, with the exception that conversation status
fields (muted/archived/hidden) are omitted, since they are not known by the
remote backend.
Constructors
| RemoteConversationV2 | |
Fields
| |
Instances
data RemoteMLSOne2OneConversation Source #
Constructors
| RemoteMLSOne2OneConversation | |
Instances
data RemoveFromConversationError Source #
Error outcomes of the leave-conversation RPC.
Constructors
| RemoveFromConversationErrorRemovalNotAllowed | |
| RemoveFromConversationErrorNotFound | |
| RemoveFromConversationErrorUnchanged |
Instances
data RemoteMLSMessageResponse Source #
Constructors
| RemoteMLSMessageOk | |
| RemoteMLSMessageMLSNotEnabled |
Instances
swaggerDoc :: OpenApi Source #