DBPAPERPaperFolderCreateArg

Objective-C

@interface DBPAPERPaperFolderCreateArg : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERPaperFolderCreateArg : NSObject, DBSerializable, NSCopying

The PaperFolderCreateArg 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

  • The name of the new Paper folder.

    Declaration

    Objective-C

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

    Swift

    var name: String { get }

  • The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.

    Declaration

    Objective-C

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

    Swift

    var parentFolderId: String? { get }

  • Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *isTeamFolder;

    Swift

    var isTeamFolder: NSNumber? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithName:(nonnull NSString *)name
                      parentFolderId:(nullable NSString *)parentFolderId
                        isTeamFolder:(nullable NSNumber *)isTeamFolder;

    Swift

    init(name: String, parentFolderId: String?, isTeamFolder: NSNumber?)

    Parameters

    name

    The name of the new Paper folder.
    parentFolderId

    The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.
    isTeamFolder

    Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithName:(nonnull NSString *)name;

    Swift

    init(name: String)

    Parameters

    name

    The name of the new Paper folder.

    Return Value

    An initialized instance.