• Frontend Script API
• <internal>
• Froca

Interface Froca

interface Froca {
attachments: Record<string, FAttachment>;
attributes: Record<string, FAttribute>;
blobPromises: Record<string, null | Promise<void | default>>;
branches: Record<string, FBranch>;
notes: Record<string, FNote>;
getAttachmentsForNote(noteId: string): Promise<FAttachment[]>;
getBlob(
entityType: string,
entityId: string,
): Promise<null | void | default>;
getBranch(
branchId: string,
silentNotFoundError?: boolean,
): undefined | FBranch;
getBranches(branchIds: string[], silentNotFoundError?: boolean): FBranch[];
getNote(
noteId: string,
silentNotFoundError?: boolean,
): Promise<null | FNote>;
getNoteFromCache(noteId: string): FNote;
getNotes(
noteIds: string[],
silentNotFoundError?: boolean,
): Promise<FNote[]>;
getNotesFromCache(
noteIds: string[],
silentNotFoundError?: boolean,
): FNote[];
}

Index

Properties

attachmentsattributesblobPromisesbranchesnotes

Methods

getAttachmentsForNotegetBlobgetBranchgetBranchesgetNotegetNoteFromCachegetNotesgetNotesFromCache

Properties

attachments

attachments: Record<string, FAttachment>

attributes

attributes: Record<string, FAttribute>

blobPromises

blobPromises: Record<string, null | Promise<void | default>>

branches

branches: Record<string, FBranch>

notes

notes: Record<string, FNote>

Methods

getAttachmentsForNote

getAttachmentsForNote(noteId: string): Promise<FAttachment[]>

Parameters

• noteId: string

Returns Promise<FAttachment[]>

getBlob

getBlob(entityType: string, entityId: string): Promise<null | void | default>

Parameters

• entityType: string
• entityId: string

Returns Promise<null | void | default>

getBranch

getBranch(branchId: string, silentNotFoundError?: boolean): undefined | FBranch

Parameters

• branchId: string
• OptionalsilentNotFoundError: boolean

Returns undefined | FBranch

getBranches

getBranches(branchIds: string[], silentNotFoundError?: boolean): FBranch[]

Parameters

• branchIds: string[]
• OptionalsilentNotFoundError: boolean

Returns FBranch[]

getNote

getNote(noteId: string, silentNotFoundError?: boolean): Promise<null | FNote>

Parameters

• noteId: string
• OptionalsilentNotFoundError: boolean

Returns Promise<null | FNote>

getNoteFromCache

getNoteFromCache(noteId: string): FNote

Parameters

• noteId: string

Returns FNote

getNotes

getNotes(noteIds: string[], silentNotFoundError?: boolean): Promise<FNote[]>

Parameters

• noteIds: string[]
• OptionalsilentNotFoundError: boolean

Returns Promise<FNote[]>

getNotesFromCache

getNotesFromCache(noteIds: string[], silentNotFoundError?: boolean): FNote[]

Parameters

• noteIds: string[]
• OptionalsilentNotFoundError: boolean

Returns FNote[]

Settings

Member Visibility

• Protected
• Inherited
• External

ThemeOSLightDark

On This Page

Properties attachmentsattributesblobPromisesbranchesnotes Methods getAttachmentsForNotegetBlobgetBranchgetBranchesgetNotegetNoteFromCachegetNotesgetNotesFromCache