Interface IServerSessionClient

interface IServerSessionClient {
    createServerSession(args: {
        repoId: string;
    }): Promise<ODataValueOfBoolean>;
    invalidateServerSession(args: {
        repoId: string;
    }): Promise<ODataValueOfBoolean>;
    refreshServerSession(args: {
        repoId: string;
    }): Promise<ODataValueOfDateTime>;
}

Implemented by

Methods

createServerSession invalidateServerSession refreshServerSession

Methods

createServerSession

invalidateServerSession

  • invalidateServerSession(args): Promise<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<ODataValueOfBoolean>

    Invalidate the server session successfully.

    Deprecated

refreshServerSession

  • refreshServerSession(args): Promise<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<ODataValueOfDateTime>

    Refresh the session successfully.

    Deprecated

Settings

Member Visibility

On This Page

Methods