gargantext-0.0.7.1.5.3: Search, map, share
Copyright(c) CNRS 2017
LicenseAGPL + CECILL v3
Maintainerteam@gargantext.org
Stabilityexperimental
PortabilityPOSIX
Safe HaskellSafe-Inferred
LanguageHaskell2010

Gargantext.API.Node.File

Description

 

Documentation

data RESPONSE #

Instances

Instances details
Accept RESPONSE # 
Instance details

Defined in Gargantext.API.Node.File

Methods

contentType :: Proxy RESPONSE -> MediaType #

contentTypes :: Proxy RESPONSE -> NonEmpty MediaType #

MimeRender RESPONSE BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

Methods

mimeRender :: Proxy RESPONSE -> BSResponse -> ByteString #

MimeUnrender RESPONSE BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

Methods

mimeUnrender :: Proxy RESPONSE -> ByteString -> Either String BSResponse #

mimeUnrenderWithType :: Proxy RESPONSE -> MediaType -> ByteString -> Either String BSResponse #

HasSwagger (WithCustomErrorScheme GargAPI) # 
Instance details

Defined in Gargantext.API.Routes

Methods

toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #

type FileApi = Summary "File download" :> ("download" :> Get '[RESPONSE] (Headers '[Header "Content-Type" Text] BSResponse)) #

fileApi :: NodeId -> GargServer FileApi #

newtype Contents #

Constructors

Contents ByteString 

newtype BSResponse #

Constructors

BSResponse ByteString 

Instances

Instances details
Generic BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

Associated Types

type Rep BSResponse :: Type -> Type #

Methods

from :: BSResponse -> Rep BSResponse x #

to :: Rep BSResponse x -> BSResponse #

ToSchema BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

Methods

declareNamedSchema :: Proxy BSResponse -> Declare (Definitions Schema) NamedSchema #

MimeRender RESPONSE BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

Methods

mimeRender :: Proxy RESPONSE -> BSResponse -> ByteString #

MimeUnrender RESPONSE BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

Methods

mimeUnrender :: Proxy RESPONSE -> ByteString -> Either String BSResponse #

mimeUnrenderWithType :: Proxy RESPONSE -> MediaType -> ByteString -> Either String BSResponse #

HasSwagger (WithCustomErrorScheme GargAPI) # 
Instance details

Defined in Gargantext.API.Routes

Methods

toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #

type Rep BSResponse # 
Instance details

Defined in Gargantext.API.Node.File

type Rep BSResponse = D1 ('MetaData "BSResponse" "Gargantext.API.Node.File" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "BSResponse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

fileDownload :: (HasSettings env, FlowCmdM env err m) => NodeId -> m (Headers '[Header "Content-Type" Text] BSResponse) #

type FileAsyncApi = Summary "File Async Api" :> ("file" :> ("add" :> AsyncJobs JobLog '[FormUrlEncoded] NewWithFile JobLog)) #

fileAsyncApi #

Arguments

:: AuthenticatedUser

The logged-in user

-> NodeId 
-> ServerT FileAsyncApi (GargM Env BackendInternalError) 

addWithFile #

Arguments

:: (HasSettings env, FlowCmdM env err m, MonadJobStatus m) 
=> AuthenticatedUser

The logged-in user

-> NodeId 
-> NewWithFile 
-> JobHandle m 
-> m ()