Class ServerSessionClient

Implements

IServerSessionClient

Index

Constructors

Properties

Methods

createServerSession invalidateServerSession processCreateServerSession processInvalidateServerSession processRefreshServerSession refreshServerSession

Constructors

constructor

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

Properties

`Protected`jsonParseReviver

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

Methods

createServerSession

createServerSession(args): Promise<ODataValueOfBoolean>
- Deprecated. This function is a no-op, always returns 200.
- Only available in Laserfiche Cloud.
Parameters
- args: {
  repoId: string;
  }
  - repoId: string
    The requested repository ID.
Returns Promise<ODataValueOfBoolean>
Create the session successfully.

Deprecated
Implementation of IServerSessionClient.createServerSession
- Defined in packages/lf-repository-api-client-v1/index.ts:6508

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
Implementation of IServerSessionClient.invalidateServerSession
- Defined in packages/lf-repository-api-client-v1/index.ts:6346

`Protected`processCreateServerSession

processCreateServerSession(response): Promise<ODataValueOfBoolean>
Parameters
- response: Response
Returns Promise<ODataValueOfBoolean>
- Defined in packages/lf-repository-api-client-v1/index.ts:6528

`Protected`processInvalidateServerSession

processInvalidateServerSession(response): Promise<ODataValueOfBoolean>
Parameters
- response: Response
Returns Promise<ODataValueOfBoolean>
- Defined in packages/lf-repository-api-client-v1/index.ts:6366

`Protected`processRefreshServerSession

processRefreshServerSession(response): Promise<ODataValueOfDateTime>
Parameters
- response: Response
Returns Promise<ODataValueOfDateTime>
- Defined in packages/lf-repository-api-client-v1/index.ts:6448

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
Implementation of IServerSessionClient.refreshServerSession
- Defined in packages/lf-repository-api-client-v1/index.ts:6428

Class ServerSessionClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fetch:function

Parameters

Returns Promise<Response>

Returns ServerSessionClient

Properties

ProtectedjsonParseReviver

Methods

createServerSession

Parameters

repoId: string

Returns Promise<ODataValueOfBoolean>

Deprecated

invalidateServerSession

Parameters

repoId: string

Returns Promise<ODataValueOfBoolean>

Deprecated

ProtectedprocessCreateServerSession

Parameters

Returns Promise<ODataValueOfBoolean>

ProtectedprocessInvalidateServerSession

Parameters

Returns Promise<ODataValueOfBoolean>

ProtectedprocessRefreshServerSession

Parameters

Returns Promise<ODataValueOfDateTime>

refreshServerSession

Parameters

repoId: string

Returns Promise<ODataValueOfDateTime>

Deprecated

Settings

On This Page

`Protected`jsonParseReviver

`Protected`processCreateServerSession

`Protected`processInvalidateServerSession

`Protected`processRefreshServerSession