Class ServerSessionClient

Implements

Constructors

constructor

Properties

jsonParseReviver

Methods

createServerSession invalidateServerSession processCreateServerSession processInvalidateServerSession processRefreshServerSession refreshServerSession

Constructors

constructor

  • new ServerSessionClient(
        baseUrl?: string,
        http?: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> },
    ): LfRepositoryClientV1.ServerSessionClient

    Parameters

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

    Returns LfRepositoryClientV1.ServerSessionClient

Properties

ProtectedjsonParseReviver

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

Methods

createServerSession

invalidateServerSession

  • invalidateServerSession(
        args: { repoId: string },
    ): Promise<LfRepositoryClientV1.ODataValueOfBoolean>
    • Deprecated.
    • Invalidates the server session.
    • Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.
    • Only available in Laserfiche Cloud.

    Parameters

    • args: { repoId: string }
      • repoId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV1.ODataValueOfBoolean>

    Invalidate the server session successfully.

    Deprecated

ProtectedprocessCreateServerSession

ProtectedprocessInvalidateServerSession

ProtectedprocessRefreshServerSession

refreshServerSession

  • refreshServerSession(
        args: { repoId: string },
    ): Promise<LfRepositoryClientV1.ODataValueOfDateTime>
    • Deprecated.
    • Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires.
    • When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token.
    • Only available in Laserfiche Cloud.

    Parameters

    • args: { repoId: string }
      • repoId: string

        The requested repository ID.

    Returns Promise<LfRepositoryClientV1.ODataValueOfDateTime>

    Refresh the session successfully.

    Deprecated

Settings

Member Visibility

On This Page

Constructors
Properties
Methods