Interface NotesAPI

interface NotesAPI {
    clearCache: () => void;
    getNotesSettings: (
        options?: ApiCallOptions,
    ) => Promise<GetNotesSettingsHttpResponse>;
    setNotesSettings: (
        body: NoteSettingsPutPayload,
        options?: ApiCallOptions,
    ) => Promise<SetNotesSettingsHttpResponse>;
}

Index

Properties

clearCache getNotesSettings setNotesSettings

Properties

clearCache

clearCache: () => void

Clears the cache for notes api requests.

Type declaration

- (): void
- Clears the cache for notes api requests.
  
  Returns void

getNotesSettings

getNotesSettings: (
options?: ApiCallOptions,
) => Promise<GetNotesSettingsHttpResponse>

Get the enablement status of the notes feature set for this tenant and user.

Type declaration

- (options?: ApiCallOptions): Promise<GetNotesSettingsHttpResponse>
- Get the enablement status of the notes feature set for this tenant and user.
  Parameters
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetNotesSettingsHttpResponse>
  Throws
  GetNotesSettingsHttpError

Throws

GetNotesSettingsHttpError

setNotesSettings

setNotesSettings: (
body: NoteSettingsPutPayload,
options?: ApiCallOptions,
) => Promise<SetNotesSettingsHttpResponse>

update the settings

Type declaration

- (
  body: NoteSettingsPutPayload,
  options?: ApiCallOptions,
  ): Promise<SetNotesSettingsHttpResponse>
- update the settings
  Parameters
  - body: NoteSettingsPutPayload
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<SetNotesSettingsHttpResponse>
  Throws
  SetNotesSettingsHttpError

Param: body

an object with the body content

Throws

SetNotesSettingsHttpError