Skip to content

Upload.md

Latest commit

 

History

History
39 lines (32 loc) · 1.99 KB

Upload.md

File metadata and controls

39 lines (32 loc) · 1.99 KB
Raw

Phrase::Upload

Properties

Name Type Description Notes
id String [optional]
filename String [optional]
format String [optional]
state String Processing state of the upload: `initialized`, `processing`, `success`, or `error`. `error` means processing failed — for example the file could not be parsed, or a provided `file_format` didn't match the file's actual content. Poll this field until it leaves `initialized`/`processing` to get the final outcome. [optional]
error_message String A user-facing message explaining why the upload failed, or `null` if the upload did not fail. This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically. [optional]
tag String Unique tag of the upload [optional]
tags Array<String> List of tags that were assigned to the uploaded keys [optional]
url String The URL to the upload in Phrase Strings app. [optional]
user UserPreview [optional]
summary UploadSummary [optional]
created_at Time [optional]
updated_at Time [optional]

Code Sample

require 'phrase'

instance = Phrase::Upload.new(id: nil,
                                 filename: nil,
                                 format: nil,
                                 state: nil,
                                 error_message: nil,
                                 tag: nil,
                                 tags: nil,
                                 url: nil,
                                 user: nil,
                                 summary: nil,
                                 created_at: nil,
                                 updated_at: nil)