DBSHARINGSharedFolderMetadataBase

@interface DBSHARINGSharedFolderMetadataBase
    : NSObject <DBSerializable, NSCopying>

The SharedFolderMetadataBase struct.

Properties of the shared folder.

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

  • The current user’s access level for this shared folder.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBSHARINGAccessLevel *_Nonnull accessType;

    Swift

    var accessType: DBSHARINGAccessLevel { get }
  • Whether this folder is inside of a team folder.

    Declaration

    Objective-C

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

    Swift

    var isInsideTeamFolder: NSNumber { get }
  • Whether this folder is a team folder https://www.dropbox.com/en/help/986.

    Declaration

    Objective-C

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

    Swift

    var isTeamFolder: NSNumber { get }
  • The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSArray<NSString *> *ownerDisplayNames;

    Swift

    var ownerDisplayNames: [String]? { get }
  • The team that owns the folder. This field is not present if the folder is not owned by a team.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) DBUSERSTeam *ownerTeam;

    Swift

    var ownerTeam: DBUSERSTeam? { get }
  • The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.

    Declaration

    Objective-C

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

    Swift

    var parentSharedFolderId: String? { get }
  • The lower-cased full path of this shared folder. Absent for unmounted folders.

    Declaration

    Objective-C

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

    Swift

    var pathLower: String? { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
      initWithAccessType:(nonnull DBSHARINGAccessLevel *)accessType
      isInsideTeamFolder:(nonnull NSNumber *)isInsideTeamFolder
            isTeamFolder:(nonnull NSNumber *)isTeamFolder
       ownerDisplayNames:(nullable NSArray<NSString *> *)ownerDisplayNames
               ownerTeam:(nullable DBUSERSTeam *)ownerTeam
    parentSharedFolderId:(nullable NSString *)parentSharedFolderId
               pathLower:(nullable NSString *)pathLower;

    Swift

    init(accessType: DBSHARINGAccessLevel, isInsideTeamFolder: NSNumber, isTeamFolder: NSNumber, ownerDisplayNames: [String]?, ownerTeam: DBUSERSTeam?, parentSharedFolderId: String?, pathLower: String?)

    Parameters

    accessType

    The current user’s access level for this shared folder.

    isInsideTeamFolder

    Whether this folder is inside of a team folder.

    isTeamFolder

    Whether this folder is a team folder https://www.dropbox.com/en/help/986.

    ownerDisplayNames

    The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.

    ownerTeam

    The team that owns the folder. This field is not present if the folder is not owned by a team.

    parentSharedFolderId

    The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.

    pathLower

    The lower-cased full path of this shared folder. Absent for unmounted folders.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithAccessType:(nonnull DBSHARINGAccessLevel *)accessType
    isInsideTeamFolder:(nonnull NSNumber *)isInsideTeamFolder
          isTeamFolder:(nonnull NSNumber *)isTeamFolder;

    Swift

    init(accessType: DBSHARINGAccessLevel, isInsideTeamFolder: NSNumber, isTeamFolder: NSNumber)

    Parameters

    accessType

    The current user’s access level for this shared folder.

    isInsideTeamFolder

    Whether this folder is inside of a team folder.

    isTeamFolder

    Whether this folder is a team folder https://www.dropbox.com/en/help/986.

    Return Value

    An initialized instance.