DBSHARINGSharedFolderMetadata

Objective-C

@interface DBSHARINGSharedFolderMetadata
    : DBSHARINGSharedFolderMetadataBase <DBSerializable, NSCopying>

Swift

class DBSHARINGSharedFolderMetadata : DBSHARINGSharedFolderMetadataBase, DBSerializable, NSCopying

The SharedFolderMetadata struct.

The metadata which includes basic information about 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.

Instance fields

linkMetadata
The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.
Declaration
Objective-C

@property (nonatomic, readonly, nullable) DBSHARINGSharedContentLinkMetadata *linkMetadata;
Swift

var linkMetadata: DBSHARINGSharedContentLinkMetadata? { get }


                    
                    
                    name

The name of the this shared folder.

Declaration

Objective-C

@property (nonatomic, copy, readonly) NSString *_Nonnull name;

Swift

var name: String { get }

permissions
Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.
Declaration
Objective-C

@property (nonatomic, readonly, nullable) NSArray<DBSHARINGFolderPermission *> *permissions;
Swift

var permissions: [DBSHARINGFolderPermission]? { get }


                    
                    
                    policy

Policies governing this shared folder.

Declaration

Objective-C

@property (nonatomic, readonly) DBSHARINGFolderPolicy *_Nonnull policy;

Swift

var policy: DBSHARINGFolderPolicy { get }


                    
                    
                    previewUrl

URL for displaying a web preview of the shared folder.

Declaration

Objective-C

@property (nonatomic, copy, readonly) NSString *_Nonnull previewUrl;

Swift

var previewUrl: String { get }


                    
                    
                    sharedFolderId

The ID of the shared folder.

Declaration

Objective-C

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

Swift

var sharedFolderId: String { get }

timeInvited
Timestamp indicating when the current user was invited to this shared folder.
Declaration
Objective-C

@property (nonatomic, readonly) NSDate *_Nonnull timeInvited;
Swift

var timeInvited: Date { get }


                    
                    
                    accessInheritance

Whether the folder inherits its members from its parent.

Declaration

Objective-C

@property (nonatomic, readonly) DBSHARINGAccessInheritance *_Nonnull accessInheritance;

Swift

var accessInheritance: DBSHARINGAccessInheritance { get }

Constructors


                    
                    
                    -initWithAccessType:isInsideTeamFolder:isTeamFolder:name:policy:previewUrl:sharedFolderId:timeInvited:ownerDisplayNames:ownerTeam:parentSharedFolderId:pathLower:parentFolderName:linkMetadata:permissions:accessInheritance:

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
                    name:(nonnull NSString *)name
                  policy:(nonnull DBSHARINGFolderPolicy *)policy
              previewUrl:(nonnull NSString *)previewUrl
          sharedFolderId:(nonnull NSString *)sharedFolderId
             timeInvited:(nonnull NSDate *)timeInvited
       ownerDisplayNames:(nullable NSArray<NSString *> *)ownerDisplayNames
               ownerTeam:(nullable DBUSERSTeam *)ownerTeam
    parentSharedFolderId:(nullable NSString *)parentSharedFolderId
               pathLower:(nullable NSString *)pathLower
        parentFolderName:(nullable NSString *)parentFolderName
            linkMetadata:
                (nullable DBSHARINGSharedContentLinkMetadata *)linkMetadata
             permissions:
                 (nullable NSArray<DBSHARINGFolderPermission *> *)permissions
       accessInheritance:
           (nullable DBSHARINGAccessInheritance *)accessInheritance;

Swift

init(accessType: DBSHARINGAccessLevel, isInsideTeamFolder: NSNumber, isTeamFolder: NSNumber, name: String, policy: DBSHARINGFolderPolicy, previewUrl: String, sharedFolderId: String, timeInvited: Date, ownerDisplayNames: [String]?, ownerTeam: DBUSERSTeam?, parentSharedFolderId: String?, pathLower: String?, parentFolderName: String?, linkMetadata: DBSHARINGSharedContentLinkMetadata?, permissions: [DBSHARINGFolderPermission]?, accessInheritance: DBSHARINGAccessInheritance?)

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.
`name`	The name of the this shared folder.
`policy`	Policies governing this shared folder.
`previewUrl`	URL for displaying a web preview of the shared folder.
`sharedFolderId`	The ID of the shared folder.
`timeInvited`	Timestamp indicating when the current user was invited to this shared folder.
`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.
`parentFolderName`	Display name for the parent folder.
`linkMetadata`	The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.
`permissions`	Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.
`accessInheritance`	Whether the folder inherits its members from its parent.

Return Value

An initialized instance.


                    
                    
                    -initWithAccessType:isInsideTeamFolder:isTeamFolder:name:policy:previewUrl:sharedFolderId:timeInvited:

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
                  name:(nonnull NSString *)name
                policy:(nonnull DBSHARINGFolderPolicy *)policy
            previewUrl:(nonnull NSString *)previewUrl
        sharedFolderId:(nonnull NSString *)sharedFolderId
           timeInvited:(nonnull NSDate *)timeInvited;

Swift

init(accessType: DBSHARINGAccessLevel, isInsideTeamFolder: NSNumber, isTeamFolder: NSNumber, name: String, policy: DBSHARINGFolderPolicy, previewUrl: String, sharedFolderId: String, timeInvited: Date)

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.
`name`	The name of the this shared folder.
`policy`	Policies governing this shared folder.
`previewUrl`	URL for displaying a web preview of the shared folder.
`sharedFolderId`	The ID of the shared folder.
`timeInvited`	Timestamp indicating when the current user was invited to this shared folder.

Return Value

An initialized instance.