Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Federation.HasNotificationEndpoint

Synopsis

class IsNotificationTag k where
- type NotificationComponent k = (c :: Component) | c -> k
class HasNotificationEndpoint t where
- type Payload t = (p :: Type) | p -> t
- type NotificationPath t :: Symbol
- type NotificationVersionTag t :: Maybe Version
- type NotificationMods t :: [Type]
type HasFedPath t = KnownSymbol (NotificationPath t)
type HasVersionRange t = MkVersionRange (NotificationMods t)
fedPath :: forall t. HasFedPath t => String
versionRange :: forall t. HasVersionRange t => VersionRange

Documentation

class IsNotificationTag k Source #

Associated Types

type NotificationComponent k = (c :: Component) | c -> k Source #

Instances

Instances details

IsNotificationTag BrigNotificationTag Source #
Instance details Defined in Wire.API.Federation.API.Brig.Notifications Associated Types type NotificationComponent BrigNotificationTag = (c :: Component) Source #
IsNotificationTag GalleyNotificationTag Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type NotificationComponent GalleyNotificationTag = (c :: Component) Source #

class HasNotificationEndpoint t Source #

Associated Types

type Payload t = (p :: Type) | p -> t Source #

The type of the payload for this endpoint

type NotificationPath t :: Symbol Source #

The central path component of a notification endpoint, e.g., "on-conversation-updated".

type NotificationVersionTag t :: Maybe Version Source #

An optional version tag to distinguish different versions of the same endpoint.

type NotificationVersionTag t = 'Nothing

type NotificationMods t :: [Type] Source #

type NotificationMods t = '[]

Instances

Instances details

HasNotificationEndpoint 'OnUserDeletedConnectionsTag Source #
Instance details Defined in Wire.API.Federation.API.Brig.Notifications Associated Types type Payload 'OnUserDeletedConnectionsTag = (p :: Type) Source # type NotificationPath 'OnUserDeletedConnectionsTag :: Symbol Source # type NotificationVersionTag 'OnUserDeletedConnectionsTag :: Maybe Version Source # type NotificationMods 'OnUserDeletedConnectionsTag :: [Type] Source #
HasNotificationEndpoint 'OnClientRemovedTag Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type Payload 'OnClientRemovedTag = (p :: Type) Source # type NotificationPath 'OnClientRemovedTag :: Symbol Source # type NotificationVersionTag 'OnClientRemovedTag :: Maybe Version Source # type NotificationMods 'OnClientRemovedTag :: [Type] Source #
HasNotificationEndpoint 'OnConversationUpdatedTag Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type Payload 'OnConversationUpdatedTag = (p :: Type) Source # type NotificationPath 'OnConversationUpdatedTag :: Symbol Source # type NotificationVersionTag 'OnConversationUpdatedTag :: Maybe Version Source # type NotificationMods 'OnConversationUpdatedTag :: [Type] Source #
HasNotificationEndpoint 'OnConversationUpdatedTagV0 Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type Payload 'OnConversationUpdatedTagV0 = (p :: Type) Source # type NotificationPath 'OnConversationUpdatedTagV0 :: Symbol Source # type NotificationVersionTag 'OnConversationUpdatedTagV0 :: Maybe Version Source # type NotificationMods 'OnConversationUpdatedTagV0 :: [Type] Source #
HasNotificationEndpoint 'OnMLSMessageSentTag Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type Payload 'OnMLSMessageSentTag = (p :: Type) Source # type NotificationPath 'OnMLSMessageSentTag :: Symbol Source # type NotificationVersionTag 'OnMLSMessageSentTag :: Maybe Version Source # type NotificationMods 'OnMLSMessageSentTag :: [Type] Source #
HasNotificationEndpoint 'OnMessageSentTag Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type Payload 'OnMessageSentTag = (p :: Type) Source # type NotificationPath 'OnMessageSentTag :: Symbol Source # type NotificationVersionTag 'OnMessageSentTag :: Maybe Version Source # type NotificationMods 'OnMessageSentTag :: [Type] Source #
HasNotificationEndpoint 'OnUserDeletedConversationsTag Source #
Instance details Defined in Wire.API.Federation.API.Galley.Notifications Associated Types type Payload 'OnUserDeletedConversationsTag = (p :: Type) Source # type NotificationPath 'OnUserDeletedConversationsTag :: Symbol Source # type NotificationVersionTag 'OnUserDeletedConversationsTag :: Maybe Version Source # type NotificationMods 'OnUserDeletedConversationsTag :: [Type] Source #

type HasFedPath t = KnownSymbol (NotificationPath t) Source #

type HasVersionRange t = MkVersionRange (NotificationMods t) Source #

fedPath :: forall t. HasFedPath t => String Source #

versionRange :: forall t. HasVersionRange t => VersionRange Source #

The federation API version range this endpoint is supported in.