Representation

public struct Representation : BoxInnerModel

Digital assets created for files stored in Box.

  • An opaque URL template to the content.

    Declaration

    Swift

    public let content: Content?
  • An opaque URL which will return status information about the file.

    Declaration

    Swift

    public let info: Info?
  • A set of static properties to distinguish between subtypes of a given representation, for example, different sizes of jpg’s. Each representation has its own set of properties.

    Declaration

    Swift

    public let properties: Properties?
  • Status string

    Declaration

    Swift

    public let status: Status?
  • Usually the extension of the format, but occasionally a name of a standard (potentially de facto) format or a proprietary format that Box supports.

    Declaration

    Swift

    public let representation: String?
  • Contains an opaque URL template to the content, which follows RFC 6570. There is an asset_path variable that should be replaced with a valid path. Valid paths are different for each representation subtype. It may change over time and should not be hard-coded or cached.

    See more

    Declaration

    Swift

    public struct Content : BoxInnerModel
  • Contains an opaque URL which will return status information about the file. It may change over time and should not be hard-coded or cached. The response is the entries object from the array with all fields available.

    See more

    Declaration

    Swift

    public struct Info : BoxInnerModel
  • A set of static properties to distinguish between subtypes of a given representation, for example, different sizes of jpgs. Each representation has its own set of properties.

    See more

    Declaration

    Swift

    public struct Properties : BoxInnerModel
  • A string with one of the following values: ‘none’, ‘pending’, ‘viewable’, ‘error’ and ‘success’. none - generating the representation needs to be manually triggered (see info.url note). pending - content is being generated but is not ready yet. viewable - like pending, though indicates that enough content is available to be useful. error - an error happened and this content is not available. success - all of the content is available and complete.

    See more

    Declaration

    Swift

    public struct Status : BoxInnerModel