DBSHARINGSharedFileMetadata

Objective-C

@interface DBSHARINGSharedFileMetadata : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGSharedFileMetadata : NSObject, DBSerializable, NSCopying

The SharedFileMetadata struct.

Properties of the shared file.

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

Instance fields

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

    Declaration

    Objective-C

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

    Swift

    var accessType: DBSHARINGAccessLevel? { get }
  • id_

    The ID of the file.

    Declaration

    Objective-C

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

    Swift

    var id_: String { get }

  • The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBSHARINGExpectedSharedContentLinkMetadata *expectedLinkMetadata;

    Swift

    var expectedLinkMetadata: DBSHARINGExpectedSharedContentLinkMetadata? { get }

  • The metadata of the link associated for the file. 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 }

  • The name of this file.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • The display names of the users that own the file. If the file 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 (nonatomic, readonly, nullable) NSArray<NSString *> *ownerDisplayNames;

    Swift

    var ownerDisplayNames: [String]? { get }

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

    Declaration

    Objective-C

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

    Swift

    var ownerTeam: DBUSERSTeam? { get }

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

    Declaration

    Objective-C

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

    Swift

    var parentSharedFolderId: String? { get }

  • The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user’s filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.

    Declaration

    Objective-C

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

    Swift

    var pathDisplay: String? { get }

  • The lower-case full path of this file. Absent for unmounted files.

    Declaration

    Objective-C

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

    Swift

    var pathLower: String? { get }

  • The sharing permissions that requesting user has on this file. This corresponds to the entries given in actions in DBSHARINGGetFileMetadataBatchArg or actions in DBSHARINGGetFileMetadataArg.

    Declaration

    Objective-C

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

    Swift

    var permissions: [DBSHARINGFilePermission]? { get }

  • Policies governing this shared file.

    Declaration

    Objective-C

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

    Swift

    var policy: DBSHARINGFolderPolicy { get }

  • URL for displaying a web preview of the shared file.

    Declaration

    Objective-C

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

    Swift

    var previewUrl: String { get }

  • Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *timeInvited;

    Swift

    var timeInvited: Date? { get }

Constructors