Class Notes

Notes

Date

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

Export

Notes

Constructors

constructor

new Notes(sdk: FilenSDK): Notes
Parameters
- sdk: FilenSDK
Returns Notes
- Defined in src/notes/index.ts:21

Methods

addParticipant

addParticipant(
    param0: {
        contactUUID: string;
        permissionsWrite: boolean;
        publicKey: string;
        uuid: string;
    },
): Promise<void>
Add a participant.
Parameters
- param0: {
      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:293

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:73

allTags

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

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

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:170

changeType

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

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

content

content(
    param0: { uuid: string },
): Promise<
    {
        content: string;
        editedTimestamp: number;
        editorId: number;
        preview: string;
        type: NoteType;
    },
>
Fetch note content.
Parameters
- param0: { 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:449

create

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

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

createTag

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

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

delete

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

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

deleteTag

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

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

duplicate

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

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

edit

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

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

editTitle

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

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

favorite

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

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

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:198

get

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

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

history

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

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

noteKey

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

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

participantPermissions

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

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

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

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

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:212

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:226

removeParticipant

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

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

renameTag

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

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

restore

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

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

restoreHistory

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

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

tagFavorite

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

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

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:1007

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:1021

trash

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

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

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:184

untag

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

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

Class Notes

Date

Export

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Notes

Methods

addParticipant

Parameters

Returns Promise<void>

Date

Async

all

Returns Promise<Note[]>

Date

Async

allTags

Parameters

Returns Promise<NoteTag[]>

Date

Async

archive

Parameters

Returns Promise<void>

Date

Async

archived

Returns Promise<Note[]>

Date

Async

changeType

Parameters

Returns Promise<void>

Date

Async

content

Parameters

Returns Promise< { content: string; editedTimestamp: number; editorId: number; preview: string; type: NoteType; },>

Date

Async

create

Parameters

Returns Promise<string>

Date

Async

createTag

Parameters

Returns Promise<string>

Date

Async

delete

Parameters

Returns Promise<void>

Date

Async

deleteTag

Parameters

Returns Promise<void>

Date

Async

duplicate

Parameters

Returns Promise<string>

Date

Async

edit

Parameters

Returns Promise<void>

Date

Async

editTitle

Parameters

Returns Promise<void>

Date

Async

favorite

Returns Promise<
{
content: string;
editedTimestamp: number;
editorId: number;
preview: string;
type: NoteType;
},
>