Skip to main content
Docs

SetActiveParams

The parameters for the setActive() method.

  • Name
    session
    Type
    Session | string | null
    Description

    The session resource or session ID (string version) to be set as active. If null, the current session is deleted.

  • Name
    organization
    Type
    Organization | string | null
    Description

    The organization resource or organization ID/slug (string version) to be set as active in the current session. If null, the currently active organization is removed as active.

  • Name
    beforeEmit? (deprecated)
    Type
    (session?: Session | null) => void | Promise<any>
    Description

    Deprecated in favor of redirectUrl. Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions.

  • Name
    redirectUrl?
    Type
    string
    Description

    The URL to redirect to just before the active session and/or organization is set.

Feedback

What did you think of this content?

Last updated on