Functions#

Functions#

events#

events(): ISessionEventListener

SessionEventEmitter instance to subscribe to events by the default session.

Returns#

ISessionEventListener

Since

1.14.0

Defined in#

packages/browser/src/defaultSession.ts:101


fetch#

fetch(input, init?): Promise<Response>

This function’s signature is equal to window.fetch, but if the current user is authenticated (see [[login]] and [[handleIncomingRedirect]]), requests made using it will include that user’s credentials. If not, this will behave just like the regular window.fetch.

Parameters#

Name

Type

input

RequestInfo | URL

init?

RequestInit

Returns#

Promise<Response>

See

https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch

Since

1.3.0

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:27941

fetch(input, init?): Promise<Response>

This function’s signature is equal to window.fetch, but if the current user is authenticated (see [[login]] and [[handleIncomingRedirect]]), requests made using it will include that user’s credentials. If not, this will behave just like the regular window.fetch.

Parameters#

Name

Type

input

string | Request | URL

init?

RequestInit

Returns#

Promise<Response>

See

https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch

Since

1.3.0

Defined in#

node_modules/@types/node/globals.d.ts:344


getDefaultSession#

getDefaultSession(): Session

Obtain the Session used when not explicitly instantiating one yourself.

When using the top-level exports fetch, login, logout, handleIncomingRedirect, onLogin and onLogout, these apply to an implicitly-instantiated Session. This function returns a reference to that Session in order to obtain e.g. the current user’s WebID.

Returns#

Session

Since

1.3.0

Defined in#

packages/browser/src/defaultSession.ts:36


handleIncomingRedirect#

handleIncomingRedirect(inputOptions?): Promise<undefined | ISessionInfo>

Completes the login process by processing the information provided by the Solid identity provider through redirect.

Parameters#

Name

Type

inputOptions

string | IHandleIncomingRedirectOptions

Returns#

Promise<undefined | ISessionInfo>

Since

1.3.0

Defined in#

packages/browser/src/Session.ts:296


login#

login(options): Promise<void>

Triggers the login process. Note that this method will redirect the user away from your app.

Parameters#

Name

Type

Description

options

ILoginInputOptions

Parameter to customize the login behaviour. In particular, two options are mandatory: options.oidcIssuer, the user’s identity provider, and options.redirectUrl, the URL to which the user will be redirected after logging in their identity provider.

Returns#

Promise<void>

This method should redirect the user away from the app: it does not return anything. The login process is completed by [[handleIncomingRedirect]].

Since

1.3.0

Defined in#

packages/browser/src/Session.ts:202


logout#

logout(options?): Promise<void>

Logs the user out of the application.

By default this does not log the user out of their Solid identity provider. In order to do so, you must set the logoutType to idp. For usage details see Session.logout.

Parameters#

Name

Type

options?

ILogoutOptions

Returns#

Promise<void>

Since

1.3.0

Defined in#

packages/browser/src/Session.ts:287