Class TagApi

Hierarchy

TagApi

Index

Constructors

Properties

Methods

addTagByNoteId create get list notesByTagId remove removeTagByNoteId update

Constructors

constructor

new TagApi(ajax: Ajax): TagApi
Parameters
- ajax: Ajax
Returns TagApi
- Defined in api/TagApi.ts:10

Properties

`Private` ajax

ajax: Ajax

Methods

addTagByNoteId

addTagByNoteId(tagId: string, noteId: string): Promise<null | NoteTagRelated>
Post a note to this endpoint to add the tag to the note. The note data must at least contain an ID property (all other properties will be ignored).
Parameters
- tagId: string
- noteId: string
Returns Promise<null | NoteTagRelated>
- Defined in api/TagApi.ts:46

create

create(param: Pick<BaseProperties, "title">): Promise<TagGetRes>
Parameters
- param: Pick<BaseProperties, "title">
Returns Promise<TagGetRes>
- Defined in api/TagApi.ts:24

get

get(id: string): Promise<TagGetRes>
Parameters
- id: string
Returns Promise<TagGetRes>
- Defined in api/TagApi.ts:20

list

list(): Promise<PageRes<TagGetRes>>
Returns Promise<PageRes<TagGetRes>>
- Defined in api/TagApi.ts:12
list<K>(pageParam: PageParam<BaseProperties> & FieldsParam<K>): Promise<PageRes<Pick<BaseProperties, K>>>
Type Parameters
- K extends keyof BaseProperties
Parameters
- pageParam: PageParam<BaseProperties> & FieldsParam<K>
Returns Promise<PageRes<Pick<BaseProperties, K>>>
- Defined in api/TagApi.ts:13

notesByTagId

notesByTagId(__namedParameters: {
id: string;
} & PageParam<BaseProperties>): Promise<PageRes<NoteGetRes>>
Parameters
- __namedParameters: {
  id: string;
  } & PageParam<BaseProperties>
Returns Promise<PageRes<NoteGetRes>>
- Defined in api/TagApi.ts:37

remove

remove(id: string): Promise<BaseProperties>
Parameters
- id: string
Returns Promise<BaseProperties>
- Defined in api/TagApi.ts:33

removeTagByNoteId

removeTagByNoteId(tagId: string, noteId: string): Promise<void>
Parameters
- tagId: string
- noteId: string
Returns Promise<void>
- Defined in api/TagApi.ts:52

update

update(param: Pick<BaseProperties, "id" | "title">): Promise<TagGetRes>
Parameters
- param: Pick<BaseProperties, "id" | "title">
Returns Promise<TagGetRes>
- Defined in api/TagApi.ts:28

Generated using TypeDoc