Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Conversation.Protocol

Synopsis

data ProtocolTag
protocolTag :: Protocol -> ProtocolTag
protocolTagSchema :: ObjectSchema SwaggerDoc ProtocolTag
protocolValidAction :: Protocol -> ConversationActionTag -> Bool
newtype Epoch = Epoch {
- epochNumber :: Word64
}
data Protocol
_ProtocolMLS :: Prism' Protocol ConversationMLSData
_ProtocolMixed :: Prism' Protocol ConversationMLSData
_ProtocolProteus :: Prism' Protocol ()
protocolSchema :: Maybe Version -> ObjectSchema SwaggerDoc Protocol
data ConversationMLSData = ConversationMLSData {
- cnvmlsGroupId :: GroupId
- cnvmlsActiveData :: Maybe ActiveMLSConversationData
}
data ActiveMLSConversationData = ActiveMLSConversationData {
- epoch :: Epoch
- epochTimestamp :: UTCTime
- ciphersuite :: CipherSuiteTag
}
optionalActiveMLSConversationDataSchema :: Maybe Version -> ObjectSchema SwaggerDoc (Maybe ActiveMLSConversationData)
cnvmlsEpoch :: ConversationMLSData -> Epoch
newtype ProtocolUpdate = ProtocolUpdate {
- unProtocolUpdate :: ProtocolTag
}

Documentation

data ProtocolTag Source #

Constructors

ProtocolProteusTag
ProtocolMLSTag
ProtocolMixedTag

Instances

Instances details

Arbitrary ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods arbitrary :: Gen ProtocolTag Source # shrink :: ProtocolTag -> [ProtocolTag] Source #
FromJSON ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods parseJSON :: Value -> Parser ProtocolTag Source # parseJSONList :: Value -> Parser [ProtocolTag] Source #
ToJSON ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods toJSON :: ProtocolTag -> Value Source # toEncoding :: ProtocolTag -> Encoding Source # toJSONList :: [ProtocolTag] -> Value Source # toEncodingList :: [ProtocolTag] -> Encoding Source #
Bounded ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods minBound :: ProtocolTag # maxBound :: ProtocolTag #
Enum ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods succ :: ProtocolTag -> ProtocolTag # pred :: ProtocolTag -> ProtocolTag # toEnum :: Int -> ProtocolTag # fromEnum :: ProtocolTag -> Int # enumFrom :: ProtocolTag -> [ProtocolTag] # enumFromThen :: ProtocolTag -> ProtocolTag -> [ProtocolTag] # enumFromTo :: ProtocolTag -> ProtocolTag -> [ProtocolTag] # enumFromThenTo :: ProtocolTag -> ProtocolTag -> ProtocolTag -> [ProtocolTag] #
Generic ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Associated Types type Rep ProtocolTag :: Type -> Type # Methods from :: ProtocolTag -> Rep ProtocolTag x # to :: Rep ProtocolTag x -> ProtocolTag #
Show ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods showsPrec :: Int -> ProtocolTag -> ShowS # show :: ProtocolTag -> String # showList :: [ProtocolTag] -> ShowS #
Eq ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods (==) :: ProtocolTag -> ProtocolTag -> Bool # (/=) :: ProtocolTag -> ProtocolTag -> Bool #
Ord ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods compare :: ProtocolTag -> ProtocolTag -> Ordering # (<) :: ProtocolTag -> ProtocolTag -> Bool # (<=) :: ProtocolTag -> ProtocolTag -> Bool # (>) :: ProtocolTag -> ProtocolTag -> Bool # (>=) :: ProtocolTag -> ProtocolTag -> Bool # max :: ProtocolTag -> ProtocolTag -> ProtocolTag # min :: ProtocolTag -> ProtocolTag -> ProtocolTag #
ToSchema ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods declareNamedSchema :: Proxy ProtocolTag -> Declare (Definitions Schema) NamedSchema Source #
ToSchema ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc ProtocolTag Source #
type Rep ProtocolTag Source #
Instance details Defined in Wire.API.Conversation.Protocol type Rep ProtocolTag = D1 ('MetaData "ProtocolTag" "Wire.API.Conversation.Protocol" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "ProtocolProteusTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ProtocolMLSTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ProtocolMixedTag" 'PrefixI 'False) (U1 :: Type -> Type)))

protocolTag :: Protocol -> ProtocolTag Source #

protocolTagSchema :: ObjectSchema SwaggerDoc ProtocolTag Source #

protocolValidAction :: Protocol -> ConversationActionTag -> Bool Source #

Certain actions need to be performed at the level of the underlying protocol (MLS, mostly) before being applied to conversations. This function returns whether a given action tag is directly applicable to a conversation with the given protocol.

newtype Epoch Source #

Constructors

Epoch
Fields epochNumber :: Word64

Instances

Instances details

Arbitrary Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods arbitrary :: Gen Epoch Source # shrink :: Epoch -> [Epoch] Source #
FromJSON Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods parseJSON :: Value -> Parser Epoch Source # parseJSONList :: Value -> Parser [Epoch] Source #
ToJSON Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods toJSON :: Epoch -> Value Source # toEncoding :: Epoch -> Encoding Source # toJSONList :: [Epoch] -> Value Source # toEncodingList :: [Epoch] -> Encoding Source #
Enum Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods succ :: Epoch -> Epoch # pred :: Epoch -> Epoch # toEnum :: Int -> Epoch # fromEnum :: Epoch -> Int # enumFrom :: Epoch -> [Epoch] # enumFromThen :: Epoch -> Epoch -> [Epoch] # enumFromTo :: Epoch -> Epoch -> [Epoch] # enumFromThenTo :: Epoch -> Epoch -> Epoch -> [Epoch] #
Show Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods showsPrec :: Int -> Epoch -> ShowS # show :: Epoch -> String # showList :: [Epoch] -> ShowS #
Eq Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods (==) :: Epoch -> Epoch -> Bool # (/=) :: Epoch -> Epoch -> Bool #
ToSchema Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods declareNamedSchema :: Proxy Epoch -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods schema :: ValueSchema NamedSwaggerDoc Epoch Source #
ParseMLS Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods parseMLS :: Get Epoch Source #
SerialiseMLS Epoch Source #
Instance details Defined in Wire.API.MLS.Epoch Methods serialiseMLS :: Epoch -> Put Source #

data Protocol Source #

Conversation protocol and protocol-specific data.

Constructors

ProtocolProteus
ProtocolMLS ConversationMLSData
ProtocolMixed ConversationMLSData

Instances

Instances details

Arbitrary Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods arbitrary :: Gen Protocol Source # shrink :: Protocol -> [Protocol] Source #
FromJSON Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods parseJSON :: Value -> Parser Protocol Source # parseJSONList :: Value -> Parser [Protocol] Source #
ToJSON Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods toJSON :: Protocol -> Value Source # toEncoding :: Protocol -> Encoding Source # toJSONList :: [Protocol] -> Value Source # toEncodingList :: [Protocol] -> Encoding Source #
Generic Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Associated Types type Rep Protocol :: Type -> Type # Methods from :: Protocol -> Rep Protocol x # to :: Rep Protocol x -> Protocol #
Show Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #
Eq Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
ToSchema Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods declareNamedSchema :: Proxy Protocol -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc Protocol Source #
ToSchema (Versioned 'V5 Protocol) Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc (Versioned 'V5 Protocol) Source #
type Rep Protocol Source #
Instance details Defined in Wire.API.Conversation.Protocol type Rep Protocol = D1 ('MetaData "Protocol" "Wire.API.Conversation.Protocol" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "ProtocolProteus" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ProtocolMLS" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConversationMLSData)) :+: C1 ('MetaCons "ProtocolMixed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConversationMLSData))))

_ProtocolMLS :: Prism' Protocol ConversationMLSData Source #

_ProtocolMixed :: Prism' Protocol ConversationMLSData Source #

_ProtocolProteus :: Prism' Protocol () Source #

protocolSchema :: Maybe Version -> ObjectSchema SwaggerDoc Protocol Source #

data ConversationMLSData Source #

Constructors

ConversationMLSData
Fields cnvmlsGroupId :: GroupId The MLS group ID associated to the conversation. cnvmlsActiveData :: Maybe ActiveMLSConversationData Information available once the conversation is active (epoch > 0).

Instances

Instances details

Arbitrary ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods arbitrary :: Gen ConversationMLSData Source # shrink :: ConversationMLSData -> [ConversationMLSData] Source #
FromJSON ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods parseJSON :: Value -> Parser ConversationMLSData Source # parseJSONList :: Value -> Parser [ConversationMLSData] Source #
ToJSON ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods toJSON :: ConversationMLSData -> Value Source # toEncoding :: ConversationMLSData -> Encoding Source # toJSONList :: [ConversationMLSData] -> Value Source # toEncodingList :: [ConversationMLSData] -> Encoding Source #
Generic ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Associated Types type Rep ConversationMLSData :: Type -> Type # Methods from :: ConversationMLSData -> Rep ConversationMLSData x # to :: Rep ConversationMLSData x -> ConversationMLSData #
Show ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods showsPrec :: Int -> ConversationMLSData -> ShowS # show :: ConversationMLSData -> String # showList :: [ConversationMLSData] -> ShowS #
Eq ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods (==) :: ConversationMLSData -> ConversationMLSData -> Bool # (/=) :: ConversationMLSData -> ConversationMLSData -> Bool #
ToSchema ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc ConversationMLSData Source #
ToSchema (Versioned 'V5 ConversationMLSData) Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc (Versioned 'V5 ConversationMLSData) Source #
type Rep ConversationMLSData Source #
Instance details Defined in Wire.API.Conversation.Protocol type Rep ConversationMLSData = D1 ('MetaData "ConversationMLSData" "Wire.API.Conversation.Protocol" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "ConversationMLSData" 'PrefixI 'True) (S1 ('MetaSel ('Just "cnvmlsGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GroupId) :*: S1 ('MetaSel ('Just "cnvmlsActiveData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ActiveMLSConversationData))))

data ActiveMLSConversationData Source #

Constructors

ActiveMLSConversationData
Fields epoch :: Epoch The current epoch number of the corresponding MLS group. epochTimestamp :: UTCTime The time stamp of the epoch. ciphersuite :: CipherSuiteTag The cipher suite to be used in the MLS group.

Instances

Instances details

Arbitrary ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods arbitrary :: Gen ActiveMLSConversationData Source # shrink :: ActiveMLSConversationData -> [ActiveMLSConversationData] Source #
FromJSON ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods parseJSON :: Value -> Parser ActiveMLSConversationData Source # parseJSONList :: Value -> Parser [ActiveMLSConversationData] Source #
ToJSON ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods toJSON :: ActiveMLSConversationData -> Value Source # toEncoding :: ActiveMLSConversationData -> Encoding Source # toJSONList :: [ActiveMLSConversationData] -> Value Source # toEncodingList :: [ActiveMLSConversationData] -> Encoding Source #
Generic ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Associated Types type Rep ActiveMLSConversationData :: Type -> Type # Methods from :: ActiveMLSConversationData -> Rep ActiveMLSConversationData x # to :: Rep ActiveMLSConversationData x -> ActiveMLSConversationData #
Show ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods showsPrec :: Int -> ActiveMLSConversationData -> ShowS # show :: ActiveMLSConversationData -> String # showList :: [ActiveMLSConversationData] -> ShowS #
Eq ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods (==) :: ActiveMLSConversationData -> ActiveMLSConversationData -> Bool # (/=) :: ActiveMLSConversationData -> ActiveMLSConversationData -> Bool #
ToSchema ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc ActiveMLSConversationData Source #
type Rep ActiveMLSConversationData Source #
Instance details Defined in Wire.API.Conversation.Protocol type Rep ActiveMLSConversationData = D1 ('MetaData "ActiveMLSConversationData" "Wire.API.Conversation.Protocol" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "ActiveMLSConversationData" 'PrefixI 'True) (S1 ('MetaSel ('Just "epoch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Epoch) :: (S1 ('MetaSel ('Just "epochTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "ciphersuite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CipherSuiteTag))))

optionalActiveMLSConversationDataSchema :: Maybe Version -> ObjectSchema SwaggerDoc (Maybe ActiveMLSConversationData) Source #

cnvmlsEpoch :: ConversationMLSData -> Epoch Source #

newtype ProtocolUpdate Source #

Constructors

ProtocolUpdate
Fields unProtocolUpdate :: ProtocolTag

Instances

Instances details

Arbitrary ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods arbitrary :: Gen ProtocolUpdate Source # shrink :: ProtocolUpdate -> [ProtocolUpdate] Source #
FromJSON ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods parseJSON :: Value -> Parser ProtocolUpdate Source # parseJSONList :: Value -> Parser [ProtocolUpdate] Source #
ToJSON ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods toJSON :: ProtocolUpdate -> Value Source # toEncoding :: ProtocolUpdate -> Encoding Source # toJSONList :: [ProtocolUpdate] -> Value Source # toEncodingList :: [ProtocolUpdate] -> Encoding Source #
Generic ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Associated Types type Rep ProtocolUpdate :: Type -> Type # Methods from :: ProtocolUpdate -> Rep ProtocolUpdate x # to :: Rep ProtocolUpdate x -> ProtocolUpdate #
Show ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods showsPrec :: Int -> ProtocolUpdate -> ShowS # show :: ProtocolUpdate -> String # showList :: [ProtocolUpdate] -> ShowS #
Eq ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods (==) :: ProtocolUpdate -> ProtocolUpdate -> Bool # (/=) :: ProtocolUpdate -> ProtocolUpdate -> Bool #
ToSchema ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods declareNamedSchema :: Proxy ProtocolUpdate -> Declare (Definitions Schema) NamedSchema Source #
ToSchema ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol Methods schema :: ValueSchema NamedSwaggerDoc ProtocolUpdate Source #
type Rep ProtocolUpdate Source #
Instance details Defined in Wire.API.Conversation.Protocol type Rep ProtocolUpdate = D1 ('MetaData "ProtocolUpdate" "Wire.API.Conversation.Protocol" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'True) (C1 ('MetaCons "ProtocolUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "unProtocolUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProtocolTag)))