Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Conversation.Role

Contents

Role
RoleName
Action
helpers

Description

This module contains the analog of some of the team-level roles & permissions types in Wire.API.Team.

Synopsis

data ConversationRole
wireConvRoles :: [ConversationRole]
convRoleWireAdmin :: ConversationRole
convRoleWireMember :: ConversationRole
data ConversationRolesList = ConversationRolesList {
- convRolesList :: [ConversationRole]
}
data RoleName
$sel:fromRoleName:RoleName :: RoleName -> Text
parseRoleName :: Text -> Maybe RoleName
roleNameWireAdmin :: RoleName
roleNameWireMember :: RoleName
data Action
- = AddConversationMember
- | RemoveConversationMember
- | ModifyConversationName
- | ModifyConversationMessageTimer
- | ModifyConversationReceiptMode
- | ModifyConversationAccess
- | ModifyOtherConversationMember
- | LeaveConversation
- | DeleteConversation
data SAction :: Action -> Type where
- SAddConversationMember :: SAction ('AddConversationMember :: Action)
- SRemoveConversationMember :: SAction ('RemoveConversationMember :: Action)
- SModifyConversationName :: SAction ('ModifyConversationName :: Action)
- SModifyConversationMessageTimer :: SAction ('ModifyConversationMessageTimer :: Action)
- SModifyConversationReceiptMode :: SAction ('ModifyConversationReceiptMode :: Action)
- SModifyConversationAccess :: SAction ('ModifyConversationAccess :: Action)
- SModifyOtherConversationMember :: SAction ('ModifyOtherConversationMember :: Action)
- SLeaveConversation :: SAction ('LeaveConversation :: Action)
- SDeleteConversation :: SAction ('DeleteConversation :: Action)
newtype Actions = Actions {
- allowedActions :: Set Action
}
type family ActionName (a :: Action) :: Symbol where ...
type family AddConversationMemberSym0 :: Action where ...
type family RemoveConversationMemberSym0 :: Action where ...
type family ModifyConversationNameSym0 :: Action where ...
type family ModifyConversationMessageTimerSym0 :: Action where ...
type family ModifyConversationReceiptModeSym0 :: Action where ...
type family ModifyConversationAccessSym0 :: Action where ...
type family ModifyOtherConversationMemberSym0 :: Action where ...
type family LeaveConversationSym0 :: Action where ...
type family DeleteConversationSym0 :: Action where ...
isValidRoleName :: Text -> Bool
roleActions :: ConversationRole -> Set Action
toConvRole :: RoleName -> Maybe Actions -> Maybe ConversationRole

Role

data ConversationRole Source #

A conversation role is associated to a user in the scope of a conversation and implies with a set of Actions. Conversation-level analog to what Role is on the team-level.

Do not expose the constructors directly, use smart constructors instead to ensure that all validation is performed.

Instances

Instances details

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

wireConvRoles :: [ConversationRole] Source #

convRoleWireAdmin :: ConversationRole Source #

convRoleWireMember :: ConversationRole Source #

data ConversationRolesList Source #

Constructors

ConversationRolesList
Fields convRolesList :: [ConversationRole]

Instances

Instances details

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

RoleName

data RoleName Source #

Instances

Instances details

Arbitrary RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods arbitrary :: Gen RoleName Source # shrink :: RoleName -> [RoleName] Source #
FromJSON RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods parseJSON :: Value -> Parser RoleName Source # parseJSONList :: Value -> Parser [RoleName] Source #
ToJSON RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods toJSON :: RoleName -> Value Source # toEncoding :: RoleName -> Encoding Source # toJSONList :: [RoleName] -> Value Source # toEncodingList :: [RoleName] -> Encoding Source #
Generic RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Associated Types type Rep RoleName :: Type -> Type # Methods from :: RoleName -> Rep RoleName x # to :: Rep RoleName x -> RoleName #
Show RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods showsPrec :: Int -> RoleName -> ShowS # show :: RoleName -> String # showList :: [RoleName] -> ShowS #
FromByteString RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods parser :: Parser RoleName Source #
ToByteString RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods builder :: RoleName -> Builder Source #
Cql RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods ctype :: Tagged RoleName ColumnType Source # toCql :: RoleName -> Value Source # fromCql :: Value -> Either String RoleName Source #
Eq RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods (==) :: RoleName -> RoleName -> Bool # (/=) :: RoleName -> RoleName -> Bool #
Ord RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods compare :: RoleName -> RoleName -> Ordering # (<) :: RoleName -> RoleName -> Bool # (<=) :: RoleName -> RoleName -> Bool # (>) :: RoleName -> RoleName -> Bool # (>=) :: RoleName -> RoleName -> Bool # max :: RoleName -> RoleName -> RoleName # min :: RoleName -> RoleName -> RoleName #
Hashable RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods hashWithSalt :: Int -> RoleName -> Int Source # hash :: RoleName -> Int Source #
ToSchema RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods declareNamedSchema :: Proxy RoleName -> Declare (Definitions Schema) NamedSchema Source #
ToSchema RoleName Source #
Instance details Defined in Wire.API.Conversation.Role Methods schema :: ValueSchema NamedSwaggerDoc RoleName Source #
type Rep RoleName Source #
Instance details Defined in Wire.API.Conversation.Role type Rep RoleName = D1 ('MetaData "RoleName" "Wire.API.Conversation.Role" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'True) (C1 ('MetaCons "RoleName" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

$sel:fromRoleName:RoleName :: RoleName -> Text Source #

parseRoleName :: Text -> Maybe RoleName Source #

roleNameWireAdmin :: RoleName Source #

roleNameWireMember :: RoleName Source #

Action

data Action Source #

These conversation-level permissions. Analogous to the team-level permissions called Perm (or Permissions).

Constructors

AddConversationMember
RemoveConversationMember
ModifyConversationName
ModifyConversationMessageTimer
ModifyConversationReceiptMode
ModifyConversationAccess
ModifyOtherConversationMember
LeaveConversation
DeleteConversation

Instances

Instances details

Arbitrary Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods arbitrary :: Gen Action Source # shrink :: Action -> [Action] Source #
FromJSON Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods parseJSON :: Value -> Parser Action Source # parseJSONList :: Value -> Parser [Action] Source #
ToJSON Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods toJSON :: Action -> Value Source # toEncoding :: Action -> Encoding Source # toJSONList :: [Action] -> Value Source # toEncodingList :: [Action] -> Encoding Source #
Bounded Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods minBound :: Action # maxBound :: Action #
Enum Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods succ :: Action -> Action # pred :: Action -> Action # toEnum :: Int -> Action # fromEnum :: Action -> Int # enumFrom :: Action -> [Action] # enumFromThen :: Action -> Action -> [Action] # enumFromTo :: Action -> Action -> [Action] # enumFromThenTo :: Action -> Action -> Action -> [Action] #
Generic Action Source #
Instance details Defined in Wire.API.Conversation.Role Associated Types type Rep Action :: Type -> Type # Methods from :: Action -> Rep Action x # to :: Rep Action x -> Action #
Show Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
Eq Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Ord Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods compare :: Action -> Action -> Ordering # (<) :: Action -> Action -> Bool # (<=) :: Action -> Action -> Bool # (>) :: Action -> Action -> Bool # (>=) :: Action -> Action -> Bool # max :: Action -> Action -> Action # min :: Action -> Action -> Action #
ToSchema Action Source #
Instance details Defined in Wire.API.Conversation.Role Methods declareNamedSchema :: Proxy Action -> Declare (Definitions Schema) NamedSchema Source #
SingKind Action Source #
Instance details Defined in Wire.API.Conversation.Role Associated Types type Demote Action = (r :: Type) Source # Methods fromSing :: forall (a :: Action). Sing a -> Demote Action Source # toSing :: Demote Action -> SomeSing Action Source #
SingI 'AddConversationMember Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'AddConversationMember Source #
SingI 'DeleteConversation Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'DeleteConversation Source #
SingI 'LeaveConversation Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'LeaveConversation Source #
SingI 'ModifyConversationAccess Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'ModifyConversationAccess Source #
SingI 'ModifyConversationMessageTimer Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'ModifyConversationMessageTimer Source #
SingI 'ModifyConversationName Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'ModifyConversationName Source #
SingI 'ModifyConversationReceiptMode Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'ModifyConversationReceiptMode Source #
SingI 'ModifyOtherConversationMember Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'ModifyOtherConversationMember Source #
SingI 'RemoveConversationMember Source #
Instance details Defined in Wire.API.Conversation.Role Methods sing :: Sing 'RemoveConversationMember Source #
SingI1 'ActionDenied Source #
Instance details Defined in Wire.API.Error.Galley Methods liftSing :: forall (x :: k1). Sing x -> Sing ('ActionDenied x) Source #
type Rep Action Source #
Instance details Defined in Wire.API.Conversation.Role type Rep Action = D1 ('MetaData "Action" "Wire.API.Conversation.Role" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (((C1 ('MetaCons "AddConversationMember" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RemoveConversationMember" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ModifyConversationName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModifyConversationMessageTimer" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ModifyConversationReceiptMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModifyConversationAccess" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ModifyOtherConversationMember" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LeaveConversation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DeleteConversation" 'PrefixI 'False) (U1 :: Type -> Type)))))
type Demote Action Source #
Instance details Defined in Wire.API.Conversation.Role type Demote Action = Action
type Sing Source #
Instance details Defined in Wire.API.Conversation.Role type Sing = SAction

data SAction :: Action -> Type where Source #

newtype Actions Source #

Constructors

Actions
Fields allowedActions :: Set Action

Instances

Instances details

Arbitrary Actions Source #
Instance details Defined in Wire.API.Conversation.Role Methods arbitrary :: Gen Actions Source # shrink :: Actions -> [Actions] Source #
Generic Actions Source #
Instance details Defined in Wire.API.Conversation.Role Associated Types type Rep Actions :: Type -> Type # Methods from :: Actions -> Rep Actions x # to :: Rep Actions x -> Actions #
Show Actions Source #
Instance details Defined in Wire.API.Conversation.Role Methods showsPrec :: Int -> Actions -> ShowS # show :: Actions -> String # showList :: [Actions] -> ShowS #
Eq Actions Source #
Instance details Defined in Wire.API.Conversation.Role Methods (==) :: Actions -> Actions -> Bool # (/=) :: Actions -> Actions -> Bool #
type Rep Actions Source #
Instance details Defined in Wire.API.Conversation.Role type Rep Actions = D1 ('MetaData "Actions" "Wire.API.Conversation.Role" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'True) (C1 ('MetaCons "Actions" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Action))))

type family ActionName (a :: Action) :: Symbol where ... Source #

Equations

ActionName 'AddConversationMember = "add_conversation_member"
ActionName 'RemoveConversationMember = "remove_conversation_member"
ActionName 'ModifyConversationName = "modify_conversation_name"
ActionName 'ModifyConversationMessageTimer = "modify_conversation_message_timer"
ActionName 'ModifyConversationReceiptMode = "modify_conversation_receipt_mode"
ActionName 'ModifyConversationAccess = "modify_conversation_access"
ActionName 'ModifyOtherConversationMember = "modify_other_conversation_member"
ActionName 'LeaveConversation = "leave_conversation"
ActionName 'DeleteConversation = "delete_conversation"

type family AddConversationMemberSym0 :: Action where ... Source #

Equations

AddConversationMemberSym0 = 'AddConversationMember

type family RemoveConversationMemberSym0 :: Action where ... Source #

Equations

RemoveConversationMemberSym0 = 'RemoveConversationMember

type family ModifyConversationNameSym0 :: Action where ... Source #

Equations

ModifyConversationNameSym0 = 'ModifyConversationName

type family ModifyConversationMessageTimerSym0 :: Action where ... Source #

Equations

ModifyConversationMessageTimerSym0 = 'ModifyConversationMessageTimer

type family ModifyConversationReceiptModeSym0 :: Action where ... Source #

Equations

ModifyConversationReceiptModeSym0 = 'ModifyConversationReceiptMode

type family ModifyConversationAccessSym0 :: Action where ... Source #

Equations

ModifyConversationAccessSym0 = 'ModifyConversationAccess

type family ModifyOtherConversationMemberSym0 :: Action where ... Source #

Equations

ModifyOtherConversationMemberSym0 = 'ModifyOtherConversationMember

type family LeaveConversationSym0 :: Action where ... Source #

Equations

LeaveConversationSym0 = 'LeaveConversation

type family DeleteConversationSym0 :: Action where ... Source #

Equations

DeleteConversationSym0 = 'DeleteConversation

helpers

isValidRoleName :: Text -> Bool Source #

roleActions :: ConversationRole -> Set Action Source #

toConvRole :: RoleName -> Maybe Actions -> Maybe ConversationRole Source #

SAddConversationMember :: SAction ('AddConversationMember :: Action)
SRemoveConversationMember :: SAction ('RemoveConversationMember :: Action)
SModifyConversationName :: SAction ('ModifyConversationName :: Action)
SModifyConversationMessageTimer :: SAction ('ModifyConversationMessageTimer :: Action)
SModifyConversationReceiptMode :: SAction ('ModifyConversationReceiptMode :: Action)
SModifyConversationAccess :: SAction ('ModifyConversationAccess :: Action)
SModifyOtherConversationMember :: SAction ('ModifyOtherConversationMember :: Action)
SLeaveConversation :: SAction ('LeaveConversation :: Action)
SDeleteConversation :: SAction ('DeleteConversation :: Action)