MetadataObject

public class MetadataObject : BoxModel

A metadata object associated with a file or a folder.

Properties

  • Declaration

    Swift

    public private(set) var rawData: [String : Any] { get }
  • id

    Identifier.

    Declaration

    Swift

    public private(set) var id: String? { get }

  • The key of the template.

    Declaration

    Swift

    public private(set) var template: String? { get }

  • The scope of the object. global and enterprise scopes are supported. The global scope contains the properties template, while the enterprise scope pertains to custom templates within the enterprise.

    Declaration

    Swift

    public private(set) var scope: String? { get }

  • The ID of the object the metadata object belongs to. Both file and folder objects are supported.

    Declaration

    Swift

    public private(set) var parent: String? { get }

  • The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

    Declaration

    Swift

    public private(set) var version: Int? { get }

  • A unique identifier for the “type” of this instance.

    Declaration

    Swift

    public private(set) var type: String? { get }

  • The last-known version of the template of the object. This is an internal system property and should not be used by a client application.

    Declaration

    Swift

    public private(set) var typeVersion: Int? { get }

  • Custom value(s) defined by the template. These values also have a corresponding display name that are viewable in applications like the Box web application.

    Declaration

    Swift

    public private(set) var keys: [String : Any] { get }

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

    public required init(json: [String : Any]) throws

    Parameters

    json

    JSON dictionary.