Class Notes

Notes

Date

2/1/2024 - 2:44:47 AM

Export

Constructors

constructor

new Notes(params): Notes
Creates an instance of Notes.
Parameters
- params: NotesConfig
Returns Notes
Date
2/9/2024 - 5:54:11 AM
- Defined in src/notes/index.ts:38

Properties

`Private` `Readonly` _noteKeyCache

_noteKeyCache: Map<string, string> = ...

`Private` `Readonly` api

api: API

`Private` `Readonly` crypto

crypto: Crypto

`Private` `Readonly` sdkConfig

sdkConfig: FilenSDKConfig

Methods

addParticipant

addParticipant(param0): Promise<void>
Add a participant.
Parameters
- param0: {
      contactUUID: string;
      permissionsWrite: boolean;
      publicKey: string;
      uuid: string;
  }
  - contactUUID: string
  - permissionsWrite: boolean
  - publicKey: string
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 1:39:20 AM

Async
- Defined in src/notes/index.ts:297

all

all(): Promise<Note[]>
Fetch all notes.

Returns Promise<Note[]>
Date
2/20/2024 - 12:26:30 AM

Async
- Defined in src/notes/index.ts:90

allTags

allTags(param0): Promise<NoteTag[]>
Decrypt all tags of a note.
Parameters
- param0: {
  tags: NoteTag[];
  }
  - tags: NoteTag[]
Returns Promise<NoteTag[]>
Date
2/20/2024 - 12:26:37 AM

Async
- Defined in src/notes/index.ts:54

archive

archive(param0): Promise<void>
Archive a note.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:48:44 AM

Async
- Defined in src/notes/index.ts:539

archived

archived(): Promise<Note[]>
Fetch all archived notes.

Returns Promise<Note[]>
Date
2/20/2024 - 12:50:24 AM

Async
- Defined in src/notes/index.ts:177

changeType

changeType(param0): Promise<void>
Change note type.
Parameters
- param0: {
  newType: NoteType;
  uuid: string;
  }
  - newType: NoteType
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:39:02 AM

Async
- Defined in src/notes/index.ts:459

content

content(param0): Promise<{
    content: string;
    editedTimestamp: number;
    editorId: number;
    preview: string;
    type: NoteType;
}>
Fetch note content.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<{
    content: string;
    editedTimestamp: number;
    editorId: number;
    preview: string;
    type: NoteType;
}>
Date
2/20/2024 - 12:32:49 AM

Async
- Defined in src/notes/index.ts:394

create

create(param0): Promise<string>
Create an empty note.
Parameters
- param0: {
  title?: string;
  uuid?: string;
  }
  - Optional title?: string
  - Optional uuid?: string
Returns Promise<string>
Date
2/19/2024 - 11:55:14 PM

Async
- Defined in src/notes/index.ts:364

createTag

createTag(param0): Promise<string>
Create a tag.
Parameters
- param0: {
  name: string;
  }
  - name: string
Returns Promise<string>
Date
2/20/2024 - 3:21:37 AM

Async
- Defined in src/notes/index.ts:795

delete

delete(param0): Promise<void>
Delete a note.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:48:38 AM

Async
- Defined in src/notes/index.ts:525

deleteTag

deleteTag(param0): Promise<void>
Delete a tag.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 4:03:05 AM

Async
- Defined in src/notes/index.ts:858

duplicate

duplicate(param0): Promise<string>
Duplicate a note.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<string>
Date
2/20/2024 - 1:40:38 AM

Async
- Defined in src/notes/index.ts:611

edit

edit(param0): Promise<void>
Edit a note.
Parameters
- param0: {
      content: string;
      type: NoteType;
      uuid: string;
  }
  - content: string
  - type: NoteType
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:43:56 AM

Async
- Defined in src/notes/index.ts:482

editTitle

editTitle(param0): Promise<void>
Edit a note's title.
Parameters
- param0: {
  title: string;
  uuid: string;
  }
  - title: string
  - uuid: string
Returns Promise<void>
Date
4/1/2024 - 5:46:41 PM

Async
- Defined in src/notes/index.ts:508

favorite

favorite(param0): Promise<void>
Toggle the favorite status of a note.
Parameters
- param0: {
  favorite: boolean;
  uuid: string;
  }
  - favorite: boolean
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:52:30 AM

Async
- Defined in src/notes/index.ts:568

favorited

favorited(): Promise<Note[]>
Fetch all favorited notes.

Returns Promise<Note[]>
Date
2/20/2024 - 12:50:40 AM

Async
- Defined in src/notes/index.ts:205

get

get(param0): Promise<Note>
Fetch a note.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<Note>
Date
2/20/2024 - 2:07:16 AM

Async
- Defined in src/notes/index.ts:158

history

history(param0): Promise<NoteHistory[]>
Fetch a content history of a note.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<NoteHistory[]>
Date
2/20/2024 - 2:03:38 AM

Async
- Defined in src/notes/index.ts:640

noteKey

noteKey(param0): Promise<string>
Get the note encryption key from owner metadata.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<string>
Date
2/20/2024 - 12:26:15 AM

Async
- Defined in src/notes/index.ts:249

participantPermissions

participantPermissions(param0): Promise<void>
Set permissions for a participant.
Parameters
- param0: {
      permissionsWrite: boolean;
      userId: number;
      uuid: string;
  }
  - permissionsWrite: boolean
  - userId: number
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 4:05:31 AM

Async
- Defined in src/notes/index.ts:341

pin

pin(param0): Promise<void>
Toggle the pinned status of a note.
Parameters
- param0: {
  pin: boolean;
  uuid: string;
  }
  - pin: boolean
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:53:31 AM

Async
- Defined in src/notes/index.ts:583

pinned

pinned(): Promise<Note[]>
Fetch all pinned notes.

Returns Promise<Note[]>
Date
2/20/2024 - 12:53:55 AM

Async
- Defined in src/notes/index.ts:219

recents

recents(): Promise<Note[]>
Fetch all notes ordered by last edit timestamp.

Returns Promise<Note[]>
Date
2/20/2024 - 12:51:06 AM

Async
- Defined in src/notes/index.ts:233

removeParticipant

removeParticipant(param0): Promise<void>
Remove a participant.
Parameters
- param0: {
  userId: number;
  uuid: string;
  }
  - userId: number
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 4:03:59 AM

Async
- Defined in src/notes/index.ts:325

renameTag

renameTag(param0): Promise<void>
Rename a tag.
Parameters
- param0: {
  name: string;
  uuid: string;
  }
  - name: string
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 4:01:29 AM

Async
- Defined in src/notes/index.ts:820

restore

restore(param0): Promise<void>
Restore a note from the archive or trash.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:52:46 AM

Async
- Defined in src/notes/index.ts:597

restoreHistory

restoreHistory(param0): Promise<void>
Restore a note from history.
Parameters
- param0: {
  id: number;
  uuid: string;
  }
  - id: number
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 4:46:26 AM

Async
- Defined in src/notes/index.ts:686

tag

tag(param0): Promise<void>
Add a tag to a note.
Parameters
- param0: {
  tag: string;
  uuid: string;
  }
  - tag: string
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 2:38:49 AM

Async
- Defined in src/notes/index.ts:701

tagFavorite

tagFavorite(param0): Promise<void>
Toggle the favorite status of a tag.
Parameters
- param0: {
  favorite: boolean;
  uuid: string;
  }
  - favorite: boolean
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 4:02:16 AM

Async
- Defined in src/notes/index.ts:844

tags

tags(): Promise<NoteTag[]>
Fetch all tags.

Returns Promise<NoteTag[]>
Date
2/20/2024 - 3:56:32 AM

Async
- Defined in src/notes/index.ts:728

tagsFavorited

tagsFavorited(): Promise<NoteTag[]>
Fetch all favorited tags.

Returns Promise<NoteTag[]>
Date
2/20/2024 - 3:58:08 AM

Async
- Defined in src/notes/index.ts:765

tagsRecents

tagsRecents(): Promise<NoteTag[]>
Fetch all tags sorted by edited timestamp.

Returns Promise<NoteTag[]>
Date
2/20/2024 - 3:58:15 AM

Async
- Defined in src/notes/index.ts:779

trash

trash(param0): Promise<void>
Trash a note.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 12:48:48 AM

Async
- Defined in src/notes/index.ts:553

trashed

trashed(): Promise<Note[]>
Fetch all trashed notes.

Returns Promise<Note[]>
Date
2/20/2024 - 12:50:33 AM

Async
- Defined in src/notes/index.ts:191

untag

untag(param0): Promise<void>
Remove a tag from a note.
Parameters
- param0: {
  tag: string;
  uuid: string;
  }
  - tag: string
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 2:38:54 AM

Async
- Defined in src/notes/index.ts:716

Generated using TypeDoc