Class UserAreasClient

Implements

IUserAreasClient

Index

Constructors

Properties

Methods

addCollectionEntries addUserAreaEntries createPersonalCollection createUserArea deletePersonalCollection deleteUserArea getPersonalCollection getPersonalCollections getRecentDocuments getRecentFolders getStarredEntries getUserArea getUserAreaEntries getUserAreas processAddCollectionEntries processAddUserAreaEntries processCreatePersonalCollection processCreateUserArea processDeletePersonalCollection processDeleteUserArea processGetPersonalCollection processGetPersonalCollections processGetRecentDocuments processGetRecentFolders processGetStarredEntries processGetUserArea processGetUserAreaEntries processGetUserAreas processRemoveCollectionEntries processRemoveUserAreaEntries processRenamePersonalCollection processStarEntries processUnstarEntries processUpdateUserArea removeCollectionEntries removeUserAreaEntries renamePersonalCollection starEntries unstarEntries updateUserArea

Constructors

constructor

new UserAreasClient(
baseUrl?: string,
http?: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> },
): UserAreasClient
Parameters
- OptionalbaseUrl: string
- Optionalhttp: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> }
Returns UserAreasClient
- Defined in packages/lf-repository-api-client-v2/index.ts:16259

Properties

`Protected`jsonParseReviver

jsonParseReviver: undefined | (key: string, value: any) => any = undefined

Methods

addCollectionEntries

addCollectionEntries(
    args: {
        collectionId: string;
        repositoryId: string;
        request: EntryIdsRequest;
    },
): Promise<PersonalCollection>
- Adds the supplied entries to the collection and returns the updated collection. Idempotent for entries already present.
- Required OAuth scope: repository.Write
Parameters
- args: { collectionId: string; repositoryId: string; request: EntryIdsRequest }
  - collectionId: string
    The ID of the personal collection.
  - repositoryId: string
    The requested repository ID.
  - request: EntryIdsRequest
    The entry IDs to add.
Returns Promise<PersonalCollection>
Successfully added the entries to the personal collection. Returns the updated collection.
Implementation of IUserAreasClient.addCollectionEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:17173

addUserAreaEntries

addUserAreaEntries(
args: { areaId: number; repositoryId: string; request: EntryIdsRequest },
): Promise<UserAreaEntry[]>
- Adds the supplied entries to the user area and returns the updated entries. Idempotent for entries already present.
- Required OAuth scope: repository.Write
Parameters
- args: { areaId: number; repositoryId: string; request: EntryIdsRequest }
  - areaId: number
    The ID of the user area.
  - repositoryId: string
    The requested repository ID.
  - request: EntryIdsRequest
    The entry IDs to add.
Returns Promise<UserAreaEntry[]>
Successfully added the entries to the user area. Returns the updated entries.
Implementation of IUserAreasClient.addUserAreaEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:17919

createPersonalCollection

createPersonalCollection(
args: { repositoryId: string; request: CreatePersonalCollectionRequest },
): Promise<PersonalCollection>
- Creates a personal collection with the supplied display name. Names must be unique (case-insensitive), fewer than 256 characters, and must not use a reserved name. A user may have at most 50 collections.
- Required OAuth scope: repository.Write
Parameters
- args: { repositoryId: string; request: CreatePersonalCollectionRequest }
  - repositoryId: string
    The requested repository ID.
  - request: CreatePersonalCollectionRequest
    The new collection's display name.
Returns Promise<PersonalCollection>
Successfully created the personal collection.
Implementation of IUserAreasClient.createPersonalCollection
- Defined in packages/lf-repository-api-client-v2/index.ts:16807

createUserArea

createUserArea(
args: { repositoryId: string; request: CreateUserAreaRequest },
): Promise<UserArea>
- Creates a user area owned by the caller. Names reserved for application-managed areas are rejected.
- Required OAuth scope: repository.Write
Parameters
- args: { repositoryId: string; request: CreateUserAreaRequest }
  - repositoryId: string
    The requested repository ID.
  - request: CreateUserAreaRequest
    The new user area's name and optional comment/data.
Returns Promise<UserArea>
Successfully created the user area.
Implementation of IUserAreasClient.createUserArea
- Defined in packages/lf-repository-api-client-v2/index.ts:17449

deletePersonalCollection

deletePersonalCollection(
args: { collectionId: string; repositoryId: string },
): Promise<void>
- Deletes the collection. Idempotent — deleting a non-existent collection succeeds.
- Required OAuth scope: repository.Write
Parameters
- args: { collectionId: string; repositoryId: string }
  - collectionId: string
    The ID of the personal collection to delete.
  - repositoryId: string
    The requested repository ID.
Returns Promise<void>
Successfully deleted the personal collection.
Implementation of IUserAreasClient.deletePersonalCollection
- Defined in packages/lf-repository-api-client-v2/index.ts:17093

deleteUserArea

deleteUserArea(args: { areaId: number; repositoryId: string }): Promise<void>
- Deletes the user area. Application-managed areas cannot be deleted through this surface (404).
- Required OAuth scope: repository.Write
Parameters
- args: { areaId: number; repositoryId: string }
  - areaId: number
    The ID of the user area to delete.
  - repositoryId: string
    The requested repository ID.
Returns Promise<void>
Successfully deleted the user area.
Implementation of IUserAreasClient.deleteUserArea
- Defined in packages/lf-repository-api-client-v2/index.ts:17735

getPersonalCollection

getPersonalCollection(
    args: {
        collectionId: string;
        repositoryId: string;
        select?: null | string;
    },
): Promise<PersonalCollection>
- Returns the requested personal collection with its display name and member entry IDs.
- Required OAuth scope: repository.Read
Parameters
- args: { collectionId: string; repositoryId: string; select?: null | string }
  - collectionId: string
    The ID of the personal collection.
  - repositoryId: string
    The requested repository ID.
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<PersonalCollection>
Successfully returned the requested personal collection.
Implementation of IUserAreasClient.getPersonalCollection
- Defined in packages/lf-repository-api-client-v2/index.ts:16899

getPersonalCollections

getPersonalCollections(
args: { repositoryId: string },
): Promise<PersonalCollection[]>
- Returns the authenticated user's personal collections, each with its display name and member entry IDs.
- Required OAuth scope: repository.Read
Parameters
- args: { repositoryId: string }
  - repositoryId: string
    The requested repository ID.
Returns Promise<PersonalCollection[]>
Successfully returned the user's personal collections.
Implementation of IUserAreasClient.getPersonalCollections
- Defined in packages/lf-repository-api-client-v2/index.ts:16719

getRecentDocuments

getRecentDocuments(
args: { documentLimit?: null | number; repositoryId: string },
): Promise<UserAreaEntry[]>
- Returns the documents in the authenticated user's Recent Documents list, most-recently-accessed first.
- The list is per-user and maintained by the Laserfiche apps; this endpoint is read-only and reflects the persisted recent-documents area, so it may briefly lag an app's in-memory recent view.
- If the user has no recent documents, an empty collection is returned.
- Required OAuth scope: repository.Read
Parameters
- args: { documentLimit?: null | number; repositoryId: string }
  - OptionaldocumentLimit?: null | number
    (optional) An optional maximum number of recent documents to return. When omitted, all entries in the user's recent-documents list are returned. A value of 0 returns an empty list; negative values are rejected.
  - repositoryId: string
    The requested repository ID.
Returns Promise<UserAreaEntry[]>
Successfully returned the user's recently accessed documents.
Implementation of IUserAreasClient.getRecentDocuments
- Defined in packages/lf-repository-api-client-v2/index.ts:16273

getRecentFolders

getRecentFolders(args: { repositoryId: string }): Promise<UserAreaEntry[]>
- Returns the folders in the authenticated user's Recent Folders list, most-recently-accessed first.
- The list is per-user and maintained by the Laserfiche apps; this endpoint is read-only.
- If the user has no recent folders, an empty collection is returned.
- Required OAuth scope: repository.Read
Parameters
- args: { repositoryId: string }
  - repositoryId: string
    The requested repository ID.
Returns Promise<UserAreaEntry[]>
Successfully returned the user's recently accessed folders.
Implementation of IUserAreasClient.getRecentFolders
- Defined in packages/lf-repository-api-client-v2/index.ts:16363

getStarredEntries

getStarredEntries(args: { repositoryId: string }): Promise<UserAreaEntry[]>
- Returns the entries in the authenticated user's Starred list.
- The list is per-user; if the user has starred nothing, an empty collection is returned.
- Required OAuth scope: repository.Read
Parameters
- args: { repositoryId: string }
  - repositoryId: string
    The requested repository ID.
Returns Promise<UserAreaEntry[]>
Successfully returned the user's starred entries.
Implementation of IUserAreasClient.getStarredEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:16450

getUserArea

getUserArea(
args: { areaId: number; repositoryId: string; select?: null | string },
): Promise<UserArea>
- Returns the requested user area. Application-managed areas are not accessible through this surface (404).
- Required OAuth scope: repository.Read
Parameters
- args: { areaId: number; repositoryId: string; select?: null | string }
  - areaId: number
    The ID of the user area.
  - repositoryId: string
    The requested repository ID.
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<UserArea>
Successfully returned the requested user area.
Implementation of IUserAreasClient.getUserArea
- Defined in packages/lf-repository-api-client-v2/index.ts:17541

getUserAreaEntries

getUserAreaEntries(
args: { areaId: number; repositoryId: string },
): Promise<UserAreaEntry[]>
- Returns the entries contained in the user area.
- Required OAuth scope: repository.Read
Parameters
- args: { areaId: number; repositoryId: string }
  - areaId: number
    The ID of the user area.
  - repositoryId: string
    The requested repository ID.
Returns Promise<UserAreaEntry[]>
Successfully returned the user area's entries.
Implementation of IUserAreasClient.getUserAreaEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:17821

getUserAreas

getUserAreas(args: { repositoryId: string }): Promise<UserArea[]>
- Returns the caller's generic user areas. Application-managed areas (Personal Collections, Starred, Recent) are excluded from this surface.
- Required OAuth scope: repository.Read
Parameters
- args: { repositoryId: string }
  - repositoryId: string
    The requested repository ID.
Returns Promise<UserArea[]>
Successfully returned the user's user areas.
Implementation of IUserAreasClient.getUserAreas
- Defined in packages/lf-repository-api-client-v2/index.ts:17362

`Protected`processAddCollectionEntries

processAddCollectionEntries(response: Response): Promise<PersonalCollection>
Parameters
- response: Response
Returns Promise<PersonalCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:17200

`Protected`processAddUserAreaEntries

processAddUserAreaEntries(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:17946

`Protected`processCreatePersonalCollection

processCreatePersonalCollection(response: Response): Promise<PersonalCollection>
Parameters
- response: Response
Returns Promise<PersonalCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:16831

`Protected`processCreateUserArea

processCreateUserArea(response: Response): Promise<UserArea>
Parameters
- response: Response
Returns Promise<UserArea>
- Defined in packages/lf-repository-api-client-v2/index.ts:17473

`Protected`processDeletePersonalCollection

processDeletePersonalCollection(response: Response): Promise<void>
Parameters
- response: Response
Returns Promise<void>
- Defined in packages/lf-repository-api-client-v2/index.ts:17115

`Protected`processDeleteUserArea

processDeleteUserArea(response: Response): Promise<void>
Parameters
- response: Response
Returns Promise<void>
- Defined in packages/lf-repository-api-client-v2/index.ts:17757

`Protected`processGetPersonalCollection

processGetPersonalCollection(response: Response): Promise<PersonalCollection>
Parameters
- response: Response
Returns Promise<PersonalCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:16924

`Protected`processGetPersonalCollections

processGetPersonalCollections(response: Response): Promise<PersonalCollection[]>
Parameters
- response: Response
Returns Promise<PersonalCollection[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:16739

`Protected`processGetRecentDocuments

processGetRecentDocuments(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:16295

`Protected`processGetRecentFolders

processGetRecentFolders(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:16383

`Protected`processGetStarredEntries

processGetStarredEntries(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:16470

`Protected`processGetUserArea

processGetUserArea(response: Response): Promise<UserArea>
Parameters
- response: Response
Returns Promise<UserArea>
- Defined in packages/lf-repository-api-client-v2/index.ts:17566

`Protected`processGetUserAreaEntries

processGetUserAreaEntries(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:17844

`Protected`processGetUserAreas

processGetUserAreas(response: Response): Promise<UserArea[]>
Parameters
- response: Response
Returns Promise<UserArea[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:17382

`Protected`processRemoveCollectionEntries

processRemoveCollectionEntries(response: Response): Promise<PersonalCollection>
Parameters
- response: Response
Returns Promise<PersonalCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:17295

`Protected`processRemoveUserAreaEntries

processRemoveUserAreaEntries(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:18048

`Protected`processRenamePersonalCollection

processRenamePersonalCollection(response: Response): Promise<PersonalCollection>
Parameters
- response: Response
Returns Promise<PersonalCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:17019

`Protected`processStarEntries

processStarEntries(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:16562

`Protected`processUnstarEntries

processUnstarEntries(response: Response): Promise<UserAreaEntry[]>
Parameters
- response: Response
Returns Promise<UserAreaEntry[]>
- Defined in packages/lf-repository-api-client-v2/index.ts:16653

`Protected`processUpdateUserArea

processUpdateUserArea(response: Response): Promise<UserArea>
Parameters
- response: Response
Returns Promise<UserArea>
- Defined in packages/lf-repository-api-client-v2/index.ts:17661

removeCollectionEntries

removeCollectionEntries(
    args: {
        collectionId: string;
        repositoryId: string;
        request: EntryIdsRequest;
    },
): Promise<PersonalCollection>
- Removes the supplied entries from the collection and returns the updated collection. Idempotent for entries not present.
- Required OAuth scope: repository.Write
Parameters
- args: { collectionId: string; repositoryId: string; request: EntryIdsRequest }
  - collectionId: string
    The ID of the personal collection.
  - repositoryId: string
    The requested repository ID.
  - request: EntryIdsRequest
    The entry IDs to remove.
Returns Promise<PersonalCollection>
Successfully removed the entries from the personal collection. Returns the updated collection.
Implementation of IUserAreasClient.removeCollectionEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:17268

removeUserAreaEntries

removeUserAreaEntries(
args: { areaId: number; repositoryId: string; request: EntryIdsRequest },
): Promise<UserAreaEntry[]>
- Removes the supplied entries from the user area and returns the updated entries. Idempotent for entries not present.
- Required OAuth scope: repository.Write
Parameters
- args: { areaId: number; repositoryId: string; request: EntryIdsRequest }
  - areaId: number
    The ID of the user area.
  - repositoryId: string
    The requested repository ID.
  - request: EntryIdsRequest
    The entry IDs to remove.
Returns Promise<UserAreaEntry[]>
Successfully removed the entries from the user area. Returns the updated entries.
Implementation of IUserAreasClient.removeUserAreaEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:18021

renamePersonalCollection

renamePersonalCollection(
    args: {
        collectionId: string;
        repositoryId: string;
        request: RenamePersonalCollectionRequest;
    },
): Promise<PersonalCollection>
- Changes the collection's display name (the collection ID is unchanged). Same name constraints as creation.
- Required OAuth scope: repository.Write
Parameters
- args: {
      collectionId: string;
      repositoryId: string;
      request: RenamePersonalCollectionRequest;
  }
  - collectionId: string
    The ID of the personal collection to rename.
  - repositoryId: string
    The requested repository ID.
  - request: RenamePersonalCollectionRequest
    The new display name.
Returns Promise<PersonalCollection>
Successfully renamed the personal collection.
Implementation of IUserAreasClient.renamePersonalCollection
- Defined in packages/lf-repository-api-client-v2/index.ts:16992

starEntries

starEntries(
args: { repositoryId: string; request: StarEntriesRequest },
): Promise<UserAreaEntry[]>
- Adds the supplied entries to the authenticated user's Starred list and returns the updated list.
- Creates the user's Starred area on first use.
- Required OAuth scope: repository.Write
Parameters
- args: { repositoryId: string; request: StarEntriesRequest }
  - repositoryId: string
    The requested repository ID.
  - request: StarEntriesRequest
    The entry IDs to star. Already-starred entries are left unchanged (idempotent).
Returns Promise<UserAreaEntry[]>
Successfully starred the requested entries. Returns the updated list of starred entries.
Implementation of IUserAreasClient.starEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:16538

unstarEntries

unstarEntries(
args: { repositoryId: string; request: StarEntriesRequest },
): Promise<UserAreaEntry[]>
- Removes the supplied entries from the authenticated user's Starred list and returns the updated list.
- Required OAuth scope: repository.Write
Parameters
- args: { repositoryId: string; request: StarEntriesRequest }
  - repositoryId: string
    The requested repository ID.
  - request: StarEntriesRequest
    The entry IDs to unstar. Entries that are not starred are ignored (idempotent).
Returns Promise<UserAreaEntry[]>
Successfully unstarred the requested entries. Returns the updated list of starred entries.
Implementation of IUserAreasClient.unstarEntries
- Defined in packages/lf-repository-api-client-v2/index.ts:16629

updateUserArea

updateUserArea(
    args: {
        areaId: number;
        repositoryId: string;
        request: UpdateUserAreaRequest;
    },
): Promise<UserArea>
- Updates the name, comment, and/or data of the user area. A renamed area cannot take a reserved name.
- Required OAuth scope: repository.Write
Parameters
- args: { areaId: number; repositoryId: string; request: UpdateUserAreaRequest }
  - areaId: number
    The ID of the user area to update.
  - repositoryId: string
    The requested repository ID.
  - request: UpdateUserAreaRequest
    The properties to change. Null properties are left unchanged.
Returns Promise<UserArea>
Successfully updated the user area.
Implementation of IUserAreasClient.updateUserArea
- Defined in packages/lf-repository-api-client-v2/index.ts:17634

Class UserAreasClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserAreasClient

Properties

ProtectedjsonParseReviver

Methods

addCollectionEntries

Parameters

collectionId: string

repositoryId: string

request: EntryIdsRequest

Returns Promise<PersonalCollection>

addUserAreaEntries

Parameters

areaId: number

repositoryId: string

request: EntryIdsRequest

Returns Promise<UserAreaEntry[]>

createPersonalCollection

Parameters

repositoryId: string

request: CreatePersonalCollectionRequest

Returns Promise<PersonalCollection>

createUserArea

Parameters

repositoryId: string

request: CreateUserAreaRequest

Returns Promise<UserArea>

deletePersonalCollection

Parameters

collectionId: string

repositoryId: string

Returns Promise<void>

deleteUserArea

Parameters

areaId: number

repositoryId: string

Returns Promise<void>

getPersonalCollection

Parameters

collectionId: string

repositoryId: string

Optionalselect?: null | string

Returns Promise<PersonalCollection>

getPersonalCollections

Parameters

repositoryId: string

Returns Promise<PersonalCollection[]>

getRecentDocuments

Parameters

OptionaldocumentLimit?: null | number

repositoryId: string

Returns Promise<UserAreaEntry[]>

getRecentFolders

Parameters

repositoryId: string

Returns Promise<UserAreaEntry[]>

getStarredEntries

Parameters

repositoryId: string

Returns Promise<UserAreaEntry[]>

getUserArea

Parameters

areaId: number

repositoryId: string

Optionalselect?: null | string

Returns Promise<UserArea>

getUserAreaEntries

Parameters

areaId: number

repositoryId: string

Returns Promise<UserAreaEntry[]>

getUserAreas

`Protected`jsonParseReviver

`Optional`select?: null | string

`Optional`documentLimit?: null | number

`Optional`select?: null | string

`Protected`processAddCollectionEntries

`Protected`processAddUserAreaEntries

`Protected`processCreatePersonalCollection

`Protected`processCreateUserArea

`Protected`processDeletePersonalCollection

`Protected`processDeleteUserArea

`Protected`processGetPersonalCollection

`Protected`processGetPersonalCollections

`Protected`processGetRecentDocuments

`Protected`processGetRecentFolders

`Protected`processGetStarredEntries

`Protected`processGetUserArea

`Protected`processGetUserAreaEntries

`Protected`processGetUserAreas

`Protected`processRemoveCollectionEntries

`Protected`processRemoveUserAreaEntries

`Protected`processRenamePersonalCollection

`Protected`processStarEntries

`Protected`processUnstarEntries

`Protected`processUpdateUserArea