Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Folder

Hierarchy

  • Folder

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Folder(object?: any): Folder

Properties

id

id: string

name

name: string

Methods

createNote

  • createNote(name: string): Promise<Note>

  • Create a note in the Folder

    Parameters

    • name: string

      Folder Name

    Returns Promise<Note>

    New Note

delete

  • delete(): Promise<any>

  • Delete Folder and its content

    Returns Promise<any>

findNote

  • findNote(name: string): Promise<Note>

notes

  • notes(): Promise<Note[]>

  • List all notes of the folder

    Returns Promise<Note[]>

    List of notes

Static create

  • create(name: string, accountName?: string): Promise<Folder>

  • Create a new Folder

    Parameters

    • name: string

      Name of the new folder

    • Optional accountName: string

      (Optional) Account Name default = "iCloud"

    Returns Promise<Folder>

    New Folder

Static find

  • find(name: string): Promise<Folder[]>

  • Find folder by name

    Parameters

    • name: string

      Folder name

    Returns Promise<Folder[]>

    List of Folders

Generated using TypeDoc