Class ServerSessionClient

Implements

IServerSessionClient

Index

Constructors

Properties

jsonParseReviver

Methods

createServerSession invalidateServerSession processCreateServerSession processInvalidateServerSession processRefreshServerSession refreshServerSession

Constructors

constructor

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

Properties

`Protected`jsonParseReviver

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

Methods

createServerSession

createServerSession(args: { repoId: string }): 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:6510

invalidateServerSession

invalidateServerSession(args: { repoId: string }): 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:6348

`Protected`processCreateServerSession

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

`Protected`processInvalidateServerSession

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

`Protected`processRefreshServerSession

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

refreshServerSession

refreshServerSession(args: { repoId: string }): 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:6430