DBSHARINGListFileMembersArg

Objective-C

@interface DBSHARINGListFileMembersArg : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGListFileMembersArg : NSObject, DBSerializable, NSCopying

The ListFileMembersArg struct.

Arguments for listFileMembers.

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 file for which you want to see members.

    Declaration

    Objective-C

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

    Swift

    var file: String { get }

  • The actions for which to return permissions on a member.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<DBSHARINGMemberAction *> *actions;

    Swift

    var actions: [DBSHARINGMemberAction]? { get }

  • Whether to include members who only have access from a parent shared folder.

    Declaration

    Objective-C

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

    Swift

    var includeInherited: NSNumber { get }

  • Number of members to return max per query. Defaults to 100 if no limit is specified.

    Declaration

    Objective-C

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

    Swift

    var limit: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithFile:(nonnull NSString *)file
             actions:(nullable NSArray<DBSHARINGMemberAction *> *)actions
    includeInherited:(nullable NSNumber *)includeInherited
               limit:(nullable NSNumber *)limit;

    Swift

    init(file: String, actions: [DBSHARINGMemberAction]?, includeInherited: NSNumber?, limit: NSNumber?)

    Parameters

    file

    The file for which you want to see members.
    actions

    The actions for which to return permissions on a member.
    includeInherited

    Whether to include members who only have access from a parent shared folder.
    limit

    Number of members to return max per query. Defaults to 100 if no limit is specified.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFile:(nonnull NSString *)file;

    Swift

    init(file: String)

    Parameters

    file

    The file for which you want to see members.

    Return Value

    An initialized instance.