DBFILESFolderSharingInfo

Objective-C

@interface DBFILESFolderSharingInfo
    : DBFILESSharingInfo <DBSerializable, NSCopying>

Swift

class DBFILESFolderSharingInfo : DBFILESSharingInfo, DBSerializable, NSCopying

The FolderSharingInfo struct.

Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • Set if the folder is contained by a shared folder.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *parentSharedFolderId;

    Swift

    var parentSharedFolderId: String? { get }

  • If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *sharedFolderId;

    Swift

    var sharedFolderId: String? { get }

  • Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don’t have read access to this folder. They do, however, have access to some sub folder.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull traverseOnly;

    Swift

    var traverseOnly: NSNumber { get }

  • Specifies that the folder cannot be accessed by the user.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull noAccess;

    Swift

    var noAccess: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithReadOnly:(nonnull NSNumber *)readOnly
                    parentSharedFolderId:
                        (nullable NSString *)parentSharedFolderId
                          sharedFolderId:(nullable NSString *)sharedFolderId
                            traverseOnly:(nullable NSNumber *)traverseOnly
                                noAccess:(nullable NSNumber *)noAccess;

    Swift

    init(readOnly: NSNumber, parentSharedFolderId: String?, sharedFolderId: String?, traverseOnly: NSNumber?, noAccess: NSNumber?)

    Parameters

    readOnly

    True if the file or folder is inside a read-only shared folder.
    parentSharedFolderId

    Set if the folder is contained by a shared folder.
    sharedFolderId

    If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
    traverseOnly

    Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don’t have read access to this folder. They do, however, have access to some sub folder.
    noAccess

    Specifies that the folder cannot be accessed by the user.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithReadOnly:(nonnull NSNumber *)readOnly;

    Swift

    init(readOnly: NSNumber)

    Parameters

    readOnly

    True if the file or folder is inside a read-only shared folder.

    Return Value

    An initialized instance.