IPWorks Cloud 2020 macOS Edition

Questions / Feedback?

ShareFileLink Type

A ShareFile share link.

Remarks

Represents a share link retrieved from ShareFile.

Fields

accessLevel
ShareFileLinkAccessLevels

The access level for the link.

This property reflects the link's access level. Possible values are:

  • 0 (sflalAnonymous)
  • 1 (sflalUserInfo)*
  • 2 (sflalEmployeesAndClients)
  • 3 (sflalEmployeesOnly)
*Requires a user to provide a first name, last name, email, and company. To modify this property see UpdateLink.

creationDate
String

The date the link was created.

This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time.

expirationDate
String

The expiration date for the link.

This property specifies the expiration date for when the link will no longer be valid. To modify this property see UpdateLink.

id
String

The id of the link.

This property specifies the id of the link.

isViewOnly
Bool

If the share items can only be viewed.

If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request.

maxDownloads
Int32

The maximum downloads for a link.

The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see UpdateLink.

notifyOnAccess
Bool

If the creator is notified when a user accesses the link.

This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to GetLinkInfo or ListLinks.

title
String

The title of the link.

This property specifies the title of the link. To modify this property see UpdateItemInfo.

totalDownloads
Int32

Total number of times the link has been downloaded from.

This property specifies the number of times an item has been downloaded from it.

type
ShareFileLinkTypes

The link's type.

This property reflects the link's type. Possible values are:

  • 0 (sfltSend)
  • 1 (sfltRequest)

url
String

The url for the link.

This property specifies the url for the link.

Constructors

public init()

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 macOS Edition - Version 20.0 [Build 8265]