WebLink

public class WebLink : BoxModel

Object that points to URLs. These objects are also known as bookmarks within the Box web application.

BoxModel

  • Box item type

    Declaration

    Swift

    public var type: String

  • Declaration

    Swift

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

Properties

  • id

    Identifier

    Declaration

    Swift

    public let id: String

  • A unique ID for use with the events.

    Declaration

    Swift

    public let sequenceId: String?

  • The entity tag of this web link. Used with If-Match headers.

    Declaration

    Swift

    public let etag: String?

  • The name of this web link.

    Declaration

    Swift

    public let name: String?
  • url

    The URL this web link points to.

    Declaration

    Swift

    public let url: URL?

  • The user who created this web link

    Declaration

    Swift

    public let createdBy: User?

  • When this web link was created

    Declaration

    Swift

    public let createdAt: Date?

  • When this web link was last updated

    Declaration

    Swift

    public let modifiedAt: Date?

  • The parent object the web link belongs to.

    Declaration

    Swift

    public let parent: Folder?

  • The description accompanying the web link. This is visible within the Box web application.

    Declaration

    Swift

    public let description: String?

  • Status of the web link

    Declaration

    Swift

    public let itemStatus: ItemStatus?

  • When this web link was last moved to the trash

    Declaration

    Swift

    public let trashedAt: Date?

  • When this web link will be permanently deleted.

    Declaration

    Swift

    public let purgedAt: Date?

  • The shared link object for this web link. Is nil if no shared link has been created.

    Declaration

    Swift

    public let sharedLink: SharedLink?

  • The path of folders to this link, starting at the root

    Declaration

    Swift

    public let pathCollection: PathCollection?

  • The user who last modified this web link

    Declaration

    Swift

    public let modifiedBy: User?

  • The user who owns this web link

    Declaration

    Swift

    public let ownedBy: User?

  • Web link permissions

    Declaration

    Swift

    public let permissions: Permissions?

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

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

    Parameters

    json

    JSON dictionary.