flow

Documentation

Index

• type Request
  • func (r *Request) ToParamsMap() map[string]string
  • func (r *Request) UploadID() string

Types

type Request

type Request struct {
	FlowChunkNumber  int32  `json:"flowChunkNumber"`  // The chunk being sent.
	FlowTotalChunks  int32  `json:"flowTotalChunks"`  // The total number of chunks to send.
	FlowChunkSize    int32  `json:"flowChunkSize"`    // The size of the chunk.
	FlowTotalSize    int64  `json:"flowTotalSize"`    // The size of the file being uploaded.
	FlowIdentifier   string `json:"flowIdentifier"`   // A unique identifier used by Flow. We generate this ID so it is guaranteed unique.
	FlowFileName     string `json:"flowFilename"`     // The file name being uploaded.
	FlowRelativePath string `json:"flowRelativePath"` // When available the relative file path.
	ProjectID        string `json:"projectID"`        // Materials Commons Project ID.
	DirectoryID      string `json:"directoryID"`      // Materials Commons Directory ID.
	FileID           string `json:"fileID"`           // Materials Commons File ID.
	Chunk            []byte `json:"-"`                // The file data.
	ChunkHash        string `json:"chunkHash"`        // The computed MD5 hash for the chunk (optional).
	FileHash         string `json:"fileHash"`         // The computed MD5 hash for the file (optional)
}

A FlowRequest encapsulates the flowjs protocol for uploading a file. The protocol supports extensions to the protocol. We extend the protocol to include Materials Commons specific information. It is also expected that the data sent by flow or another client will be placed in chunkData.

func (*Request) ToParamsMap

func (r *Request) ToParamsMap() map[string]string

ToMultipartParams converts a flow Request into a map of key/value pairs suitable for mulitpart param fields.

func (*Request) UploadID

func (r *Request) UploadID() string

UploadID returns the id uses to identify this request with a particular upload. This method exists so we can change how this id is computed without impacting any code that depends on this id.