wire-api-federation-0.1.0: The Wire server-to-server API for federation
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Federation.API.Galley.Notifications

Synopsis

Documentation

data GalleyNotificationTag Source #

Instances

Instances details
Bounded GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Enum GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Associated Types

type Rep GalleyNotificationTag :: Type -> Type #

Show GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Eq GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

HasNotificationEndpoint 'OnClientRemovedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

HasNotificationEndpoint 'OnConversationUpdatedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

HasNotificationEndpoint 'OnConversationUpdatedTagV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

HasNotificationEndpoint 'OnMLSMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

HasNotificationEndpoint 'OnMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

HasNotificationEndpoint 'OnUserDeletedConversationsTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

IsNotificationTag GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep GalleyNotificationTag = D1 ('MetaData "GalleyNotificationTag" "Wire.API.Federation.API.Galley.Notifications" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) ((C1 ('MetaCons "OnClientRemovedTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OnMessageSentTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OnMLSMessageSentTag" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "OnConversationUpdatedTagV0" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OnConversationUpdatedTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OnUserDeletedConversationsTag" 'PrefixI 'False) (U1 :: Type -> Type))))
type NotificationComponent GalleyNotificationTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationMods 'OnClientRemovedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationMods 'OnConversationUpdatedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationMods 'OnConversationUpdatedTagV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationMods 'OnMLSMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationMods 'OnMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationMods 'OnUserDeletedConversationsTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnClientRemovedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnClientRemovedTag = "on-client-removed"
type NotificationPath 'OnConversationUpdatedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnConversationUpdatedTag = "on-conversation-updated"
type NotificationPath 'OnConversationUpdatedTagV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnConversationUpdatedTagV0 = "on-conversation-updated"
type NotificationPath 'OnMLSMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnMLSMessageSentTag = "on-mls-message-sent"
type NotificationPath 'OnMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnMessageSentTag = "on-message-sent"
type NotificationPath 'OnUserDeletedConversationsTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationPath 'OnUserDeletedConversationsTag = "on-user-deleted-conversations"
type NotificationVersionTag 'OnClientRemovedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationVersionTag 'OnConversationUpdatedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationVersionTag 'OnConversationUpdatedTagV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationVersionTag 'OnMLSMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationVersionTag 'OnMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type NotificationVersionTag 'OnUserDeletedConversationsTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Payload 'OnClientRemovedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Payload 'OnConversationUpdatedTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Payload 'OnConversationUpdatedTagV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Payload 'OnMLSMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Payload 'OnMessageSentTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Payload 'OnUserDeletedConversationsTag Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

data ClientRemovedRequest Source #

Constructors

ClientRemovedRequest 

Fields

Instances

Instances details
Arbitrary ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

FromJSON ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToJSON ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Associated Types

type Rep ClientRemovedRequest :: Type -> Type #

Show ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Eq ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToSchema ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep ClientRemovedRequest Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep ClientRemovedRequest = D1 ('MetaData "ClientRemovedRequest" "Wire.API.Federation.API.Galley.Notifications" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "ClientRemovedRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: (S1 ('MetaSel ('Just "client") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ClientId) :*: S1 ('MetaSel ('Just "convs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ConvId]))))

data RemoteMessage conv Source #

Instances

Instances details
Functor RemoteMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Methods

fmap :: (a -> b) -> RemoteMessage a -> RemoteMessage b #

(<$) :: a -> RemoteMessage b -> RemoteMessage a #

Arbitrary conv => Arbitrary (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

FromJSON conv => FromJSON (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToJSON conv => ToJSON (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Associated Types

type Rep (RemoteMessage conv) :: Type -> Type #

Methods

from :: RemoteMessage conv -> Rep (RemoteMessage conv) x #

to :: Rep (RemoteMessage conv) x -> RemoteMessage conv #

Show conv => Show (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Methods

showsPrec :: Int -> RemoteMessage conv -> ShowS #

show :: RemoteMessage conv -> String #

showList :: [RemoteMessage conv] -> ShowS #

Eq conv => Eq (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Methods

(==) :: RemoteMessage conv -> RemoteMessage conv -> Bool #

(/=) :: RemoteMessage conv -> RemoteMessage conv -> Bool #

ToSchema a => ToSchema (RemoteMessage a) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep (RemoteMessage conv) Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

data RemoteMLSMessage Source #

Instances

Instances details
Arbitrary RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

FromJSON RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToJSON RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Associated Types

type Rep RemoteMLSMessage :: Type -> Type #

Show RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Eq RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToSchema RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep RemoteMLSMessage Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

data ConversationUpdateV0 Source #

Constructors

ConversationUpdateV0 

Fields

  • cuTime :: UTCTime
     
  • cuOrigUserId :: Qualified UserId
     
  • cuConvId :: ConvId

    The unqualified ID of the conversation where the update is happening. The ID is local to the sender to prevent putting arbitrary domain that is different than that of the backend making a conversation membership update request.

  • cuAlreadyPresentUsers :: [UserId]

    A list of users from the receiving backend that need to be sent notifications about this change. This is required as we do not expect a non-conversation owning backend to have an indexed mapping of conversation to users.

  • cuAction :: SomeConversationAction

    Information on the specific action that caused the update.

Instances

Instances details
FromJSON ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToJSON ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Associated Types

type Rep ConversationUpdateV0 :: Type -> Type #

Show ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Eq ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToSchema ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep ConversationUpdateV0 Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep ConversationUpdateV0 = D1 ('MetaData "ConversationUpdateV0" "Wire.API.Federation.API.Galley.Notifications" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "ConversationUpdateV0" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cuTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "cuOrigUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Qualified UserId))) :*: (S1 ('MetaSel ('Just "cuConvId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConvId) :*: (S1 ('MetaSel ('Just "cuAlreadyPresentUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UserId]) :*: S1 ('MetaSel ('Just "cuAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeConversationAction)))))

data ConversationUpdate Source #

Constructors

ConversationUpdate 

Fields

  • time :: UTCTime
     
  • origUserId :: Qualified UserId
     
  • convId :: ConvId

    The unqualified ID of the conversation where the update is happening. The ID is local to the sender to prevent putting arbitrary domain that is different than that of the backend making a conversation membership update request.

  • alreadyPresentUsers :: [UserId]

    A list of users from the receiving backend that need to be sent notifications about this change. This is required as we do not expect a non-conversation owning backend to have an indexed mapping of conversation to users.

  • action :: SomeConversationAction

    Information on the specific action that caused the update.

Instances

Instances details
FromJSON ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToJSON ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Associated Types

type Rep ConversationUpdate :: Type -> Type #

Show ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Eq ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToSchema ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep ConversationUpdate Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep ConversationUpdate = D1 ('MetaData "ConversationUpdate" "Wire.API.Federation.API.Galley.Notifications" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "ConversationUpdate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "origUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Qualified UserId))) :*: (S1 ('MetaSel ('Just "convId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConvId) :*: (S1 ('MetaSel ('Just "alreadyPresentUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UserId]) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeConversationAction)))))

data UserDeletedConversationsNotification Source #

Constructors

UserDeletedConversationsNotification 

Fields

Instances

Instances details
Arbitrary UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

FromJSON UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToJSON UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Generic UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Show UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

Eq UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

ToSchema UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep UserDeletedConversationsNotification Source # 
Instance details

Defined in Wire.API.Federation.API.Galley.Notifications

type Rep UserDeletedConversationsNotification = D1 ('MetaData "UserDeletedConversationsNotification" "Wire.API.Federation.API.Galley.Notifications" "wire-api-federation-0.1.0-ARZyNQKMq4lCWdaEdWVlig" 'False) (C1 ('MetaCons "UserDeletedConversationsNotification" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "conversations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Range 1 UserDeletedNotificationMaxConvs [ConvId]))))