smart_city
v6.0.0

View Source SmartCity.HostedFile (smart_city v6.0.0)

Defines the information needed to process uploaded files by components of the system including the files' type, parent identifier, and location info.

Link to this section Summary

Types

bucket()
id()
key()
t()

Functions

new(msg)

Instantiates an instance of a file upload event struct.

Link to this section Types

Link to this type

bucket()

View Source 
@type bucket() :: String.t()
Link to this type

id()

View Source 
@type id() :: String.t()
Link to this type

key()

View Source 
@type key() :: String.t()
Link to this type

t()

View Source 
@type t() :: %SmartCity.HostedFile{
  bucket: bucket(),
  dataset_id: id(),
  key: key(),
  mime_type: SmartCity.Helpers.mime_type(),
  version: term()
}

Link to this section Functions

Link to this function

new(msg)

View Source 
@spec new(String.t() | map()) :: {:ok, map()} | {:error, term()}

Instantiates an instance of a file upload event struct.