slack-web-2.2.0.0: Bindings for the Slack web API
Safe HaskellNone
LanguageHaskell2010

Web.Slack.Experimental.Views

Description

Publishing views using the Blocks API.

This is used for App Home and modals.

https://api.slack.com/methods/views.publish

Since: 2.1.0.0

Synopsis

Types

data SlackView inner Source #

View definition for some Slack surface. Has an inner type of either ModalView or HomeTabView.

https://api.slack.com/reference/surfaces/views

Since: 2.1.0.0

Constructors

SlackView 

Fields

Instances

Instances details
FromJSON inner => FromJSON (SlackView inner) Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

parseJSON :: Value -> Parser (SlackView inner) #

parseJSONList :: Value -> Parser [SlackView inner] #

omittedField :: Maybe (SlackView inner) #

ToJSON inner => ToJSON (SlackView inner) Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

toJSON :: SlackView inner -> Value #

toEncoding :: SlackView inner -> Encoding #

toJSONList :: [SlackView inner] -> Value #

toEncodingList :: [SlackView inner] -> Encoding #

omitField :: SlackView inner -> Bool #

Generic (SlackView inner) Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Associated Types

type Rep (SlackView inner) 
Instance details

Defined in Web.Slack.Experimental.Views

type Rep (SlackView inner) = D1 ('MetaData "SlackView" "Web.Slack.Experimental.Views" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) (C1 ('MetaCons "SlackView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector SlackBlock)) :*: S1 ('MetaSel ('Just "privateMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "callbackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 inner)))))

Methods

from :: SlackView inner -> Rep (SlackView inner) x #

to :: Rep (SlackView inner) x -> SlackView inner #

Show inner => Show (SlackView inner) Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

showsPrec :: Int -> SlackView inner -> ShowS #

show :: SlackView inner -> String #

showList :: [SlackView inner] -> ShowS #

Eq inner => Eq (SlackView inner) Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

(==) :: SlackView inner -> SlackView inner -> Bool #

(/=) :: SlackView inner -> SlackView inner -> Bool #

type Rep (SlackView inner) Source # 
Instance details

Defined in Web.Slack.Experimental.Views

type Rep (SlackView inner) = D1 ('MetaData "SlackView" "Web.Slack.Experimental.Views" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) (C1 ('MetaCons "SlackView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector SlackBlock)) :*: S1 ('MetaSel ('Just "privateMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "callbackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 inner)))))

data HomeTabView Source #

Since: 2.1.0.0

Constructors

HomeTabView 

Fields

Instances

Instances details
FromJSON HomeTabView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

parseJSON :: Value -> Parser HomeTabView #

parseJSONList :: Value -> Parser [HomeTabView] #

omittedField :: Maybe HomeTabView #

ToJSON HomeTabView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

toJSON :: HomeTabView -> Value #

toEncoding :: HomeTabView -> Encoding #

toJSONList :: [HomeTabView] -> Value #

toEncodingList :: [HomeTabView] -> Encoding #

omitField :: HomeTabView -> Bool #

Generic HomeTabView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Associated Types

type Rep HomeTabView 
Instance details

Defined in Web.Slack.Experimental.Views

type Rep HomeTabView = D1 ('MetaData "HomeTabView" "Web.Slack.Experimental.Views" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) (C1 ('MetaCons "HomeTabView" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Expected "home"))))

Methods

from :: HomeTabView -> Rep HomeTabView x #

to :: Rep HomeTabView x -> HomeTabView #

Show HomeTabView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

showsPrec :: Int -> HomeTabView -> ShowS #

show :: HomeTabView -> String #

showList :: [HomeTabView] -> ShowS #

Eq HomeTabView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

(==) :: HomeTabView -> HomeTabView -> Bool #

(/=) :: HomeTabView -> HomeTabView -> Bool #

type Rep HomeTabView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

type Rep HomeTabView = D1 ('MetaData "HomeTabView" "Web.Slack.Experimental.Views" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) (C1 ('MetaCons "HomeTabView" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Expected "home"))))

data ModalView Source #

Modal view

https://api.slack.com/reference/surfaces/views#modal

Since: 2.1.0.0

Constructors

ModalView 

Fields

Instances

Instances details
FromJSON ModalView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

parseJSON :: Value -> Parser ModalView #

parseJSONList :: Value -> Parser [ModalView] #

omittedField :: Maybe ModalView #

ToJSON ModalView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

toJSON :: ModalView -> Value #

toEncoding :: ModalView -> Encoding #

toJSONList :: [ModalView] -> Value #

toEncodingList :: [ModalView] -> Encoding #

omitField :: ModalView -> Bool #

Generic ModalView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Associated Types

type Rep ModalView 
Instance details

Defined in Web.Slack.Experimental.Views

type Rep ModalView = D1 ('MetaData "ModalView" "Web.Slack.Experimental.Views" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) (C1 ('MetaCons "ModalView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Expected "modal")) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlackPlainTextOnly)) :*: (S1 ('MetaSel ('Just "close") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SlackPlainTextOnly)) :*: (S1 ('MetaSel ('Just "submit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SlackPlainTextOnly)) :*: S1 ('MetaSel ('Just "submitDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

Methods

from :: ModalView -> Rep ModalView x #

to :: Rep ModalView x -> ModalView #

Show ModalView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

showsPrec :: Int -> ModalView -> ShowS #

show :: ModalView -> String #

showList :: [ModalView] -> ShowS #

Eq ModalView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

(==) :: ModalView -> ModalView -> Bool #

(/=) :: ModalView -> ModalView -> Bool #

type Rep ModalView Source # 
Instance details

Defined in Web.Slack.Experimental.Views

type Rep ModalView = D1 ('MetaData "ModalView" "Web.Slack.Experimental.Views" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) (C1 ('MetaCons "ModalView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Expected "modal")) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlackPlainTextOnly)) :*: (S1 ('MetaSel ('Just "close") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SlackPlainTextOnly)) :*: (S1 ('MetaSel ('Just "submit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SlackPlainTextOnly)) :*: S1 ('MetaSel ('Just "submitDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))

data Expected (lit :: Symbol) Source #

Expected a given value as a string. Useful for type fields in json.

Constructors

Expected 

Instances

Instances details
KnownSymbol lit => FromJSON (Expected lit) Source # 
Instance details

Defined in Web.Slack.AesonUtils

Methods

parseJSON :: Value -> Parser (Expected lit) #

parseJSONList :: Value -> Parser [Expected lit] #

omittedField :: Maybe (Expected lit) #

KnownSymbol lit => ToJSON (Expected lit) Source # 
Instance details

Defined in Web.Slack.AesonUtils

Methods

toJSON :: Expected lit -> Value #

toEncoding :: Expected lit -> Encoding #

toJSONList :: [Expected lit] -> Value #

toEncodingList :: [Expected lit] -> Encoding #

omitField :: Expected lit -> Bool #

KnownSymbol lit => Show (Expected lit) Source # 
Instance details

Defined in Web.Slack.AesonUtils

Methods

showsPrec :: Int -> Expected lit -> ShowS #

show :: Expected lit -> String #

showList :: [Expected lit] -> ShowS #

KnownSymbol lit => Eq (Expected lit) Source # 
Instance details

Defined in Web.Slack.AesonUtils

Methods

(==) :: Expected lit -> Expected lit -> Bool #

(/=) :: Expected lit -> Expected lit -> Bool #

Requests and responses

data PublishReq Source #

Publishes the App Home view for a user.

https://api.slack.com/methods/views.publish

Since: 2.1.0.0

Constructors

PublishReq 

Fields

Instances

Instances details
Show PublishReq Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

showsPrec :: Int -> PublishReq -> ShowS #

show :: PublishReq -> String #

showList :: [PublishReq] -> ShowS #

ToForm PublishReq Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

toForm :: PublishReq -> Form #

data PublishResp Source #

Since: 2.1.0.0

Constructors

PublishResp 

Fields

Instances

Instances details
FromJSON PublishResp Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

parseJSON :: Value -> Parser PublishResp #

parseJSONList :: Value -> Parser [PublishResp] #

omittedField :: Maybe PublishResp #

ToJSON PublishResp Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

toJSON :: PublishResp -> Value #

toEncoding :: PublishResp -> Encoding #

toJSONList :: [PublishResp] -> Value #

toEncodingList :: [PublishResp] -> Encoding #

omitField :: PublishResp -> Bool #

Show PublishResp Source # 
Instance details

Defined in Web.Slack.Experimental.Views

Methods

showsPrec :: Int -> PublishResp -> ShowS #

show :: PublishResp -> String #

showList :: [PublishResp] -> ShowS #

type Api = "views.publish" :> (AuthProtect "token" :> (ReqBody '[FormUrlEncoded] PublishReq :> Post '[JSON] (ResponseJSON PublishResp))) Source #

Since: 2.1.0.0

viewsPublish :: SlackConfig -> PublishReq -> IO (Response PublishResp) Source #

Publishes the App Home view for a user.

https://api.slack.com/methods/views.publish

Since: 2.1.0.0