DBSHARINGSharedContentLinkMetadata

@interface DBSHARINGSharedContentLinkMetadata
    : DBSHARINGSharedContentLinkMetadataBase <DBSerializable, NSCopying>

The SharedContentLinkMetadata struct.

Metadata of a shared link for a file or folder.

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

  • The content inside this folder with link audience different than this folder’s. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
        DBSHARINGAudienceExceptions *audienceExceptions;

    Swift

    var audienceExceptions: DBSHARINGAudienceExceptions? { get }
  • url

    The URL of the link.

    Declaration

    Objective-C

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

    Swift

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

    Declaration

    Objective-C

    - (nonnull instancetype)
            initWithAudienceOptions:
                (nonnull NSArray<DBSHARINGLinkAudience *> *)audienceOptions
                    currentAudience:(nonnull DBSHARINGLinkAudience *)currentAudience
                    linkPermissions:(nonnull NSArray<DBSHARINGLinkPermission *> *)
                                        linkPermissions
                  passwordProtected:(nonnull NSNumber *)passwordProtected
                                url:(nonnull NSString *)url
                        accessLevel:(nullable DBSHARINGAccessLevel *)accessLevel
    audienceRestrictingSharedFolder:
        (nullable DBSHARINGAudienceRestrictingSharedFolder *)
            audienceRestrictingSharedFolder
                             expiry:(nullable NSDate *)expiry
                 audienceExceptions:
                     (nullable DBSHARINGAudienceExceptions *)audienceExceptions;

    Swift

    init(audienceOptions: [DBSHARINGLinkAudience], currentAudience: DBSHARINGLinkAudience, linkPermissions: [DBSHARINGLinkPermission], passwordProtected: NSNumber, url: String, accessLevel: DBSHARINGAccessLevel?, audienceRestrictingSharedFolder: DBSHARINGAudienceRestrictingSharedFolder?, expiry: Date?, audienceExceptions: DBSHARINGAudienceExceptions?)

    Parameters

    audienceOptions

    The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The ‘default’ audience option is always available if the user can modify link settings.

    currentAudience

    The current audience of the link.

    linkPermissions

    A list of permissions for actions you can perform on the link.

    passwordProtected

    Whether the link is protected by a password.

    url

    The URL of the link.

    accessLevel

    The access level on the link for this file.

    audienceRestrictingSharedFolder

    The shared folder that prevents the link audience for this link from being more restrictive.

    expiry

    Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.

    audienceExceptions

    The content inside this folder with link audience different than this folder’s. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithAudienceOptions:
        (nonnull NSArray<DBSHARINGLinkAudience *> *)audienceOptions
            currentAudience:(nonnull DBSHARINGLinkAudience *)currentAudience
            linkPermissions:
                (nonnull NSArray<DBSHARINGLinkPermission *> *)linkPermissions
          passwordProtected:(nonnull NSNumber *)passwordProtected
                        url:(nonnull NSString *)url;

    Swift

    init(audienceOptions: [DBSHARINGLinkAudience], currentAudience: DBSHARINGLinkAudience, linkPermissions: [DBSHARINGLinkPermission], passwordProtected: NSNumber, url: String)

    Parameters

    audienceOptions

    The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The ‘default’ audience option is always available if the user can modify link settings.

    currentAudience

    The current audience of the link.

    linkPermissions

    A list of permissions for actions you can perform on the link.

    passwordProtected

    Whether the link is protected by a password.

    url

    The URL of the link.

    Return Value

    An initialized instance.