Class UserAreasClient

Implements

Constructors

constructor

Properties

jsonParseReviver

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> },
    ): LfRepositoryClientV2.UserAreasClient

    Parameters

    • OptionalbaseUrl: string
    • Optionalhttp: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> }

    Returns LfRepositoryClientV2.UserAreasClient

Properties

ProtectedjsonParseReviver

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

Methods

addCollectionEntries

addUserAreaEntries

createPersonalCollection

createUserArea

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.

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.

getPersonalCollection

  • getPersonalCollection(
        args: {
            collectionId: string;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.PersonalCollection>

    Successfully returned the requested personal collection.

getPersonalCollections

  • getPersonalCollections(
        args: { repositoryId: string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.PersonalCollection[]>

    Successfully returned the user's personal collections.

getRecentDocuments

  • getRecentDocuments(
        args: { documentLimit?: null | number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.UserAreaEntry[]>

    Successfully returned the user's recently accessed documents.

getRecentFolders

  • getRecentFolders(
        args: { repositoryId: string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.UserAreaEntry[]>

    Successfully returned the user's recently accessed folders.

getStarredEntries

  • getStarredEntries(
        args: { repositoryId: string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.UserAreaEntry[]>

    Successfully returned the user's starred entries.

getUserArea

  • getUserArea(
        args: { areaId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.UserArea>

    Successfully returned the requested user area.

getUserAreaEntries

  • getUserAreaEntries(
        args: { areaId: number; repositoryId: string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.UserAreaEntry[]>

    Successfully returned the user area's entries.

getUserAreas

  • getUserAreas(
        args: { repositoryId: string },
    ): Promise<LfRepositoryClientV2.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<LfRepositoryClientV2.UserArea[]>

    Successfully returned the user's user areas.

ProtectedprocessAddCollectionEntries

ProtectedprocessAddUserAreaEntries

ProtectedprocessCreatePersonalCollection

ProtectedprocessCreateUserArea

ProtectedprocessDeletePersonalCollection

  • processDeletePersonalCollection(response: Response): Promise<void>

    Parameters

    • response: Response

    Returns Promise<void>

ProtectedprocessDeleteUserArea

  • processDeleteUserArea(response: Response): Promise<void>

    Parameters

    • response: Response

    Returns Promise<void>

ProtectedprocessGetPersonalCollection

ProtectedprocessGetPersonalCollections

ProtectedprocessGetRecentDocuments

ProtectedprocessGetRecentFolders

ProtectedprocessGetStarredEntries

ProtectedprocessGetUserArea

ProtectedprocessGetUserAreaEntries

ProtectedprocessGetUserAreas

ProtectedprocessRemoveCollectionEntries

ProtectedprocessRemoveUserAreaEntries

ProtectedprocessRenamePersonalCollection

ProtectedprocessStarEntries

ProtectedprocessUnstarEntries

ProtectedprocessUpdateUserArea

removeCollectionEntries

removeUserAreaEntries

renamePersonalCollection

starEntries

unstarEntries

updateUserArea

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addCollectionEntriesaddUserAreaEntriescreatePersonalCollectioncreateUserAreadeletePersonalCollectiondeleteUserAreagetPersonalCollectiongetPersonalCollectionsgetRecentDocumentsgetRecentFoldersgetStarredEntriesgetUserAreagetUserAreaEntriesgetUserAreasprocessAddCollectionEntriesprocessAddUserAreaEntriesprocessCreatePersonalCollectionprocessCreateUserAreaprocessDeletePersonalCollectionprocessDeleteUserAreaprocessGetPersonalCollectionprocessGetPersonalCollectionsprocessGetRecentDocumentsprocessGetRecentFoldersprocessGetStarredEntriesprocessGetUserAreaprocessGetUserAreaEntriesprocessGetUserAreasprocessRemoveCollectionEntriesprocessRemoveUserAreaEntriesprocessRenamePersonalCollectionprocessStarEntriesprocessUnstarEntriesprocessUpdateUserArearemoveCollectionEntriesremoveUserAreaEntriesrenamePersonalCollectionstarEntriesunstarEntriesupdateUserArea