DBSHARINGSharedContentLinkMetadataBase

Objective-C

@interface DBSHARINGSharedContentLinkMetadataBase
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGSharedContentLinkMetadataBase : NSObject, DBSerializable, NSCopying

The SharedContentLinkMetadataBase struct.

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

Instance fields


                    
                    
                    accessLevel

The access level on the link for this file.

Declaration

Objective-C

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

Swift

var accessLevel: DBSHARINGAccessLevel? { get }

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.
Declaration
Objective-C

@property (nonatomic, readonly) NSArray<DBSHARINGLinkAudience *> *_Nonnull audienceOptions;
Swift

var audienceOptions: [DBSHARINGLinkAudience] { get }


                    
                    
                    audienceRestrictingSharedFolder

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

Declaration

Objective-C

@property (nonatomic, readonly, nullable) DBSHARINGAudienceRestrictingSharedFolder *audienceRestrictingSharedFolder;

Swift

var audienceRestrictingSharedFolder: DBSHARINGAudienceRestrictingSharedFolder? { get }


                    
                    
                    currentAudience

The current audience of the link.

Declaration

Objective-C

@property (nonatomic, readonly) DBSHARINGLinkAudience *_Nonnull currentAudience;

Swift

var currentAudience: DBSHARINGLinkAudience { get }

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.
Declaration
Objective-C

@property (nonatomic, readonly, nullable) NSDate *expiry;
Swift

var expiry: Date? { get }


                    
                    
                    linkPermissions

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

Declaration

Objective-C

@property (nonatomic, readonly) NSArray<DBSHARINGLinkPermission *> *_Nonnull linkPermissions;

Swift

var linkPermissions: [DBSHARINGLinkPermission] { get }


                    
                    
                    passwordProtected

Whether the link is protected by a password.

Declaration

Objective-C

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

Swift

var passwordProtected: NSNumber { get }

Constructors


                    
                    
                    -initWithAudienceOptions:currentAudience:linkPermissions:passwordProtected:accessLevel:audienceRestrictingSharedFolder:expiry:

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
                        accessLevel:(nullable DBSHARINGAccessLevel *)accessLevel
    audienceRestrictingSharedFolder:
        (nullable DBSHARINGAudienceRestrictingSharedFolder *)
            audienceRestrictingSharedFolder
                             expiry:(nullable NSDate *)expiry;

Swift

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

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.
`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.

Return Value

An initialized instance.


                    
                    
                    -initWithAudienceOptions:currentAudience:linkPermissions:passwordProtected:

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;

Swift

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

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.

Return Value

An initialized instance.