Safe Haskell	None
Language	Haskell2010

Web.Slack.Files.Types

Description

Type definitions for the Slack files APIs. See https://api.slack.com/messaging/files.

Since: 1.6.0.0

Synopsis

newtype FileId = FileId {
- unFileId :: Text
}
data FileMode
- = Hosted
- | External
- | Snippet
- | Post
- | FileAccess
- | Email
- | Other Text
data FileObjectVisible = FileObjectVisible {
- id :: FileId
- created :: UnixTimestamp
- name :: Text
- title :: Text
- mimetype :: Text
- urlPrivate :: Text
- isExternal :: Bool
- size :: Int
- mode :: FileMode
}
data FileObject
- = VisibleFileObject FileObjectVisible
- | CheckFileInfo FileId

Documentation

newtype FileId Source #

ID for a file, which looks something like F2147483862.

Constructors

FileId
Fields unFileId :: Text

Instances

Instances details

FromJSON FileId Source #
Instance details Defined in Web.Slack.Files.Types Methods parseJSON :: Value -> Parser FileId # parseJSONList :: Value -> Parser [FileId] # omittedField :: Maybe FileId #
ToJSON FileId Source #
Instance details Defined in Web.Slack.Files.Types Methods toJSON :: FileId -> Value # toEncoding :: FileId -> Encoding # toJSONList :: [FileId] -> Value # toEncodingList :: [FileId] -> Encoding # omitField :: FileId -> Bool #
Show FileId Source #
Instance details Defined in Web.Slack.Files.Types Methods showsPrec :: Int -> FileId -> ShowS # show :: FileId -> String # showList :: [FileId] -> ShowS #
Eq FileId Source #
Instance details Defined in Web.Slack.Files.Types Methods (==) :: FileId -> FileId -> Bool # (/=) :: FileId -> FileId -> Bool #

data FileMode Source #

Constructors

Hosted
External
Snippet
Post
FileAccess
Email	https://slack.com/help/articles/206819278-Send-emails-to-Slack Since: 1.6.1.0
Other Text	Other file modes. Since: 1.6.1.0

Instances

Instances details

FromJSON FileMode Source #

Instance details

Defined in Web.Slack.Files.Types

Methods

parseJSON :: Value -> Parser FileMode #

parseJSONList :: Value -> Parser [FileMode] #

omittedField :: Maybe FileMode #

ToJSON FileMode Source #

Instance details

Defined in Web.Slack.Files.Types

Methods

toJSON :: FileMode -> Value #

toEncoding :: FileMode -> Encoding #

toJSONList :: [FileMode] -> Value #

toEncodingList :: [FileMode] -> Encoding #

omitField :: FileMode -> Bool #

Generic FileMode Source #

Instance details

Defined in Web.Slack.Files.Types

Associated Types

type Rep FileMode

Instance details

Defined in Web.Slack.Files.Types

type Rep FileMode = D1 ('MetaData "FileMode" "Web.Slack.Files.Types" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) ((C1 ('MetaCons "Hosted" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "External" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Snippet" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Post" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FileAccess" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Email" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Other" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

Methods

from :: FileMode -> Rep FileMode x #

to :: Rep FileMode x -> FileMode #

Show FileMode Source #

Instance details

Defined in Web.Slack.Files.Types

Methods

showsPrec :: Int -> FileMode -> ShowS #

show :: FileMode -> String #

showList :: [FileMode] -> ShowS #

Eq FileMode Source #

Instance details

Defined in Web.Slack.Files.Types

Methods

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

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

type Rep FileMode Source #

Instance details

Defined in Web.Slack.Files.Types

type Rep FileMode = D1 ('MetaData "FileMode" "Web.Slack.Files.Types" "slack-web-2.2.0.0-2X4wKOtrXI0LMO4H3hWcQt" 'False) ((C1 ('MetaCons "Hosted" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "External" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Snippet" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Post" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FileAccess" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Email" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Other" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data FileObjectVisible Source #

https://api.slack.com/types/file

Constructors

FileObjectVisible
Fields id :: FileId created :: UnixTimestamp name :: Text title :: Text mimetype :: Text urlPrivate :: Text isExternal :: Bool size :: Int mode :: FileMode

Instances

Instances details

FromJSON FileObjectVisible Source #
Instance details Defined in Web.Slack.Files.Types Methods parseJSON :: Value -> Parser FileObjectVisible # parseJSONList :: Value -> Parser [FileObjectVisible] # omittedField :: Maybe FileObjectVisible #
ToJSON FileObjectVisible Source #
Instance details Defined in Web.Slack.Files.Types Methods toJSON :: FileObjectVisible -> Value # toEncoding :: FileObjectVisible -> Encoding # toJSONList :: [FileObjectVisible] -> Value # toEncodingList :: [FileObjectVisible] -> Encoding # omitField :: FileObjectVisible -> Bool #
Show FileObjectVisible Source #
Instance details Defined in Web.Slack.Files.Types Methods showsPrec :: Int -> FileObjectVisible -> ShowS # show :: FileObjectVisible -> String # showList :: [FileObjectVisible] -> ShowS #
Eq FileObjectVisible Source #
Instance details Defined in Web.Slack.Files.Types Methods (==) :: FileObjectVisible -> FileObjectVisible -> Bool # (/=) :: FileObjectVisible -> FileObjectVisible -> Bool #

data FileObject Source #

Constructors

VisibleFileObject FileObjectVisible	File object is visible
CheckFileInfo FileId	File object is in a shared channel so `files.info` must be invoked to get any further details. See https://api.slack.com/types/file#slack_connect_files for more details.

Instances

Instances details

FromJSON FileObject Source #
Instance details Defined in Web.Slack.Files.Types Methods parseJSON :: Value -> Parser FileObject # parseJSONList :: Value -> Parser [FileObject] # omittedField :: Maybe FileObject #
ToJSON FileObject Source #
Instance details Defined in Web.Slack.Files.Types Methods toJSON :: FileObject -> Value # toEncoding :: FileObject -> Encoding # toJSONList :: [FileObject] -> Value # toEncodingList :: [FileObject] -> Encoding # omitField :: FileObject -> Bool #
Show FileObject Source #
Instance details Defined in Web.Slack.Files.Types Methods showsPrec :: Int -> FileObject -> ShowS # show :: FileObject -> String # showList :: [FileObject] -> ShowS #
Eq FileObject Source #
Instance details Defined in Web.Slack.Files.Types Methods (==) :: FileObject -> FileObject -> Bool # (/=) :: FileObject -> FileObject -> Bool #