Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Connection

Contents

UserConnection
Requests

Description

docs/reference/user/connection.md {#RefConnection}

Types for connections between users.

Synopsis

data UserConnection = UserConnection {
- ucFrom :: UserId
- ucTo :: Qualified UserId
- ucStatus :: Relation
- ucLastUpdate :: UTCTimeMillis
- ucConvId :: Maybe (Qualified ConvId)
}
data UserConnectionList = UserConnectionList {
- clConnections :: [UserConnection]
- clHasMore :: Bool
}
type ConnectionsPage = MultiTablePage "Connections" "connections" LocalOrRemoteTable UserConnection
type ConnectionPagingState = MultiTablePagingState ConnectionPagingName LocalOrRemoteTable
pattern ConnectionPagingState :: tables -> Maybe ByteString -> MultiTablePagingState name tables
data Relation
- = Accepted
- | Blocked
- | Pending
- | Ignored
- | Sent
- | Cancelled
- | MissingLegalholdConsent
data RelationWithHistory
relationDropHistory :: RelationWithHistory -> Relation
relationWithHistory :: Relation -> RelationWithHistory
data ConnectionRequest = ConnectionRequest {
- crUser :: UserId
- crName :: Range 1 256 Text
}
newtype ConnectionUpdate = ConnectionUpdate {
- cuStatus :: Relation
}
type ListConnectionsRequestPaginated = GetMultiTablePageRequest "Connections" LocalOrRemoteTable 500 100

UserConnection

data UserConnection Source #

Exact state of the connection between two users, stored in Brig database (see lookupConnections).

Connection states have a direction -- e.g. if A sends a connection request to B, we'll create connections (A, B, Sent) and (B, A, Pending).

Constructors

UserConnection
Fields ucFrom :: UserId ucTo :: Qualified UserId ucStatus :: Relation ucLastUpdate :: UTCTimeMillis When `$sel:ucStatus:UserConnection` was last changed ucConvId :: Maybe (Qualified ConvId)

Instances

Instances details

Arbitrary UserConnection Source #
Instance details Defined in Wire.API.Connection Methods arbitrary :: Gen UserConnection Source # shrink :: UserConnection -> [UserConnection] Source #
FromJSON UserConnection Source #
Instance details Defined in Wire.API.Connection Methods parseJSON :: Value -> Parser UserConnection Source # parseJSONList :: Value -> Parser [UserConnection] Source #
ToJSON UserConnection Source #
Instance details Defined in Wire.API.Connection Methods toJSON :: UserConnection -> Value Source # toEncoding :: UserConnection -> Encoding Source # toJSONList :: [UserConnection] -> Value Source # toEncodingList :: [UserConnection] -> Encoding Source #
Generic UserConnection Source #
Instance details Defined in Wire.API.Connection Associated Types type Rep UserConnection :: Type -> Type # Methods from :: UserConnection -> Rep UserConnection x # to :: Rep UserConnection x -> UserConnection #
Show UserConnection Source #
Instance details Defined in Wire.API.Connection Methods showsPrec :: Int -> UserConnection -> ShowS # show :: UserConnection -> String # showList :: [UserConnection] -> ShowS #
Eq UserConnection Source #
Instance details Defined in Wire.API.Connection Methods (==) :: UserConnection -> UserConnection -> Bool # (/=) :: UserConnection -> UserConnection -> Bool #
ToSchema UserConnection Source #
Instance details Defined in Wire.API.Connection Methods declareNamedSchema :: Proxy UserConnection -> Declare (Definitions Schema) NamedSchema Source #
ToSchema UserConnection Source #
Instance details Defined in Wire.API.Connection Methods schema :: ValueSchema NamedSwaggerDoc UserConnection Source #
type Rep UserConnection Source #
Instance details Defined in Wire.API.Connection type Rep UserConnection = D1 ('MetaData "UserConnection" "Wire.API.Connection" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "UserConnection" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ucFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserId) :: S1 ('MetaSel ('Just "ucTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Qualified UserId))) :: (S1 ('MetaSel ('Just "ucStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Relation) :: (S1 ('MetaSel ('Just "ucLastUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTimeMillis) :: S1 ('MetaSel ('Just "ucConvId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Qualified ConvId)))))))

data UserConnectionList Source #

Response type for endpoints returning lists of connections.

Constructors

UserConnectionList
Fields clConnections :: [UserConnection] clHasMore :: Bool Pagination flag ("we have more results")

Instances

Instances details

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

type ConnectionsPage = MultiTablePage "Connections" "connections" LocalOrRemoteTable UserConnection Source #

A page in response to ListConnectionsRequestPaginated

type ConnectionPagingState = MultiTablePagingState ConnectionPagingName LocalOrRemoteTable Source #

pattern ConnectionPagingState :: tables -> Maybe ByteString -> MultiTablePagingState name tables Source #

data Relation Source #

Possible relations between two users. For detailed descriptions of these states, see:

docs/reference/user/connection.md {#RefConnectionStates}

Constructors

Accepted
Blocked
Pending
Ignored
Sent
Cancelled
MissingLegalholdConsent	behaves like blocked, the extra constructor is just to inform why.

Instances

Instances details

Arbitrary Relation Source #
Instance details Defined in Wire.API.Connection Methods arbitrary :: Gen Relation Source # shrink :: Relation -> [Relation] Source #
FromJSON Relation Source #
Instance details Defined in Wire.API.Connection Methods parseJSON :: Value -> Parser Relation Source # parseJSONList :: Value -> Parser [Relation] Source #
ToJSON Relation Source #
Instance details Defined in Wire.API.Connection Methods toJSON :: Relation -> Value Source # toEncoding :: Relation -> Encoding Source # toJSONList :: [Relation] -> Value Source # toEncodingList :: [Relation] -> Encoding Source #
Bounded Relation Source #
Instance details Defined in Wire.API.Connection Methods minBound :: Relation # maxBound :: Relation #
Enum Relation Source #
Instance details Defined in Wire.API.Connection Methods succ :: Relation -> Relation # pred :: Relation -> Relation # toEnum :: Int -> Relation # fromEnum :: Relation -> Int # enumFrom :: Relation -> [Relation] # enumFromThen :: Relation -> Relation -> [Relation] # enumFromTo :: Relation -> Relation -> [Relation] # enumFromThenTo :: Relation -> Relation -> Relation -> [Relation] #
Generic Relation Source #
Instance details Defined in Wire.API.Connection Associated Types type Rep Relation :: Type -> Type # Methods from :: Relation -> Rep Relation x # to :: Rep Relation x -> Relation #
Show Relation Source #
Instance details Defined in Wire.API.Connection Methods showsPrec :: Int -> Relation -> ShowS # show :: Relation -> String # showList :: [Relation] -> ShowS #
Eq Relation Source #
Instance details Defined in Wire.API.Connection Methods (==) :: Relation -> Relation -> Bool # (/=) :: Relation -> Relation -> Bool #
Ord Relation Source #
Instance details Defined in Wire.API.Connection Methods compare :: Relation -> Relation -> Ordering # (<) :: Relation -> Relation -> Bool # (<=) :: Relation -> Relation -> Bool # (>) :: Relation -> Relation -> Bool # (>=) :: Relation -> Relation -> Bool # max :: Relation -> Relation -> Relation # min :: Relation -> Relation -> Relation #
FromHttpApiData Relation Source #
Instance details Defined in Wire.API.Connection Methods parseUrlPiece :: Text -> Either Text Relation Source # parseHeader :: ByteString -> Either Text Relation Source # parseQueryParam :: Text -> Either Text Relation Source #
ToHttpApiData Relation Source #
Instance details Defined in Wire.API.Connection Methods toUrlPiece :: Relation -> Text Source # toEncodedUrlPiece :: Relation -> Builder Source # toHeader :: Relation -> ByteString Source # toQueryParam :: Relation -> Text Source # toEncodedQueryParam :: Relation -> Builder Source #
ToParamSchema Relation Source #
Instance details Defined in Wire.API.Connection Methods toParamSchema :: Proxy Relation -> Schema Source #
ToSchema Relation Source #
Instance details Defined in Wire.API.Connection Methods declareNamedSchema :: Proxy Relation -> Declare (Definitions Schema) NamedSchema Source #
ToSchema Relation Source #
Instance details Defined in Wire.API.Connection Methods schema :: ValueSchema NamedSwaggerDoc Relation Source #
type Rep Relation Source #
Instance details Defined in Wire.API.Connection type Rep Relation = D1 ('MetaData "Relation" "Wire.API.Connection" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) ((C1 ('MetaCons "Accepted" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Blocked" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Pending" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Ignored" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sent" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cancelled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MissingLegalholdConsent" 'PrefixI 'False) (U1 :: Type -> Type))))

data RelationWithHistory Source #

updateConnectionInternal, requires knowledge of the previous state (before MissingLegalholdConsent), but the clients don't need that information. To avoid having to change the API, we introduce an internal variant of Relation with surjective mapping relationDropHistory.

Constructors

AcceptedWithHistory
BlockedWithHistory
PendingWithHistory
IgnoredWithHistory
SentWithHistory
CancelledWithHistory
MissingLegalholdConsentFromAccepted
MissingLegalholdConsentFromBlocked
MissingLegalholdConsentFromPending
MissingLegalholdConsentFromIgnored
MissingLegalholdConsentFromSent
MissingLegalholdConsentFromCancelled

Instances

Instances details

Arbitrary RelationWithHistory Source #
Instance details Defined in Wire.API.Connection Methods arbitrary :: Gen RelationWithHistory Source # shrink :: RelationWithHistory -> [RelationWithHistory] Source #
Generic RelationWithHistory Source #
Instance details Defined in Wire.API.Connection Associated Types type Rep RelationWithHistory :: Type -> Type # Methods from :: RelationWithHistory -> Rep RelationWithHistory x # to :: Rep RelationWithHistory x -> RelationWithHistory #
Show RelationWithHistory Source #
Instance details Defined in Wire.API.Connection Methods showsPrec :: Int -> RelationWithHistory -> ShowS # show :: RelationWithHistory -> String # showList :: [RelationWithHistory] -> ShowS #
Cql RelationWithHistory Source #
Instance details Defined in Wire.API.Connection Methods ctype :: Tagged RelationWithHistory ColumnType Source # toCql :: RelationWithHistory -> Value Source # fromCql :: Value -> Either String RelationWithHistory Source #
Eq RelationWithHistory Source #
Instance details Defined in Wire.API.Connection Methods (==) :: RelationWithHistory -> RelationWithHistory -> Bool # (/=) :: RelationWithHistory -> RelationWithHistory -> Bool #
Ord RelationWithHistory Source #
Instance details Defined in Wire.API.Connection Methods compare :: RelationWithHistory -> RelationWithHistory -> Ordering # (<) :: RelationWithHistory -> RelationWithHistory -> Bool # (<=) :: RelationWithHistory -> RelationWithHistory -> Bool # (>) :: RelationWithHistory -> RelationWithHistory -> Bool # (>=) :: RelationWithHistory -> RelationWithHistory -> Bool # max :: RelationWithHistory -> RelationWithHistory -> RelationWithHistory # min :: RelationWithHistory -> RelationWithHistory -> RelationWithHistory #
type Rep RelationWithHistory Source #
Instance details Defined in Wire.API.Connection type Rep RelationWithHistory = D1 ('MetaData "RelationWithHistory" "Wire.API.Connection" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (((C1 ('MetaCons "AcceptedWithHistory" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BlockedWithHistory" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PendingWithHistory" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "IgnoredWithHistory" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SentWithHistory" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CancelledWithHistory" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "MissingLegalholdConsentFromAccepted" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MissingLegalholdConsentFromBlocked" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MissingLegalholdConsentFromPending" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "MissingLegalholdConsentFromIgnored" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MissingLegalholdConsentFromSent" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MissingLegalholdConsentFromCancelled" 'PrefixI 'False) (U1 :: Type -> Type)))))

relationDropHistory :: RelationWithHistory -> Relation Source #

relationWithHistory :: Relation -> RelationWithHistory Source #

Convert a Relation to RelationWithHistory. This is to be used only if the MissingLegalholdConsent case does not need to be supported.

Requests

data ConnectionRequest Source #

Payload type for a connection request from one user to another.

Constructors

ConnectionRequest
Fields crUser :: UserId Connection recipient crName :: Range 1 256 Text Name of the conversation to be created. This is not used in any meaningful way anymore. The clients just write the name of the target user here and it is ignored later. (In the past, this was used; but due to spam, clients started ignoring it)

Instances

Instances details

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

newtype ConnectionUpdate Source #

Payload type for "please change the status of this connection".

Constructors

ConnectionUpdate
Fields cuStatus :: Relation

Instances

Instances details

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

type ListConnectionsRequestPaginated = GetMultiTablePageRequest "Connections" LocalOrRemoteTable 500 100 Source #

Request to get a paginated list of connection