Back to bricks list

Research documentation

Getting Started

Developer guide

Release

CLI

Technical Documentation

Resources

Tasks

Protocols

Other Classes

AbstractDbManager

BadRequestException

BaseHTTPException

BaseTestCaseLight

CheckBeforeTaskResult

CommunityService

CondaShellProxy

ConnectorPartSpec

ConverterRunner

CredentialsDataBasic

CredentialsDataLab

CredentialsDataOther

CredentialsDataS3

CredentialsParam

CredentialsType

CurrentUserService

DataframeAggregatorHelper

DataframeDataFilterHelper

DataframeFilterHelper

DataFrameRField

DataframeScalerHelper

DispatchedMessage

EntityNavigator

EntityNavigatorService

ExceptionHandler

ExceptionResponse

ExpressionBuilder

ExternalApiService

ForbiddenException

GwsCorePackages

MambaShellProxy

MessageDispatcher

MessageObserver

NoteSearchBuilder

NoteTemplateParam

NoteTemplateService

NotFoundException

NumericValidator

OpenAiChatMessage

OpenAiChatParam

PrimitiveRField

ProgressBarMessageObserver

ProgressBarService

ProtocolService

PythonCodeParam

ResourceDownloaderBase

ResourceSearchBuilder

ResourceService

ResourceTransfertService

RichTextBlockModificationDTO

RichTextBlockModificationWithUserDTO

RichTextBlockType

RichTextFigureData

RichTextFileData

RichTextFormulaData

RichTextListData

RichTextListItem

RichTextModificationDifferenceDTO

RichTextModificationsDTO

RichTextModificationType

RichTextNoteResourceViewData

RichTextObjectType

RichTextParagraphData

RichTextParagraphHeaderData

RichTextParagraphHeaderLevel

RichTextParagraphListData

RichTextParagraphListItemData

RichTextParagraphText

RichTextResourceViewData

RichTextTimestampData

RichTextUserDTO

RichTextVariableData

RichTextViewFileData

ScatterPlot2DView

ScenarioCreationType

ScenarioProcessStatus

ScenarioRunService

ScenarioSaveDTO

ScenarioSearchBuilder

ScenarioService

ScenarioTemplate

ScenarioTemplateFactory

ScenarioTransfertService

SerializableObjectJson

SerializableRField

StackedBarPlotView

StreamlitAppManager

StreamlitProcess

TableAnnotatorHelper

TableColumnSelector

TableColumnTagToRowExtractor

TableColumnTagUnfolder

TableConcatHelper

TableHeaderInfo

TableOperationHelper

TableRowSelector

TableRowTagToColumnExtractor

TableRowTagUnfolder

TableScalerHelper

TableTagAggregatorHelper

TableUnfolderHelper

TaskFileDownloader

TypingDeprecated

TypingIconColor

UnauthorizedException

UserCredentialsDTO

VennDiagramView

UserService

Functions

ACTIVATE_USER - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

User

CREATE_OR_UPDATE_USER_DTO - @classmethod

Parameters:

Name	Type	Default value	Description
user_dto	`UserFullDTO`

Return type:

User

CREATE_SYSUSER - @classmethod

Create the system user

DEACTIVATE_USER - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

User

GET_ALL_REAL_USERS - @classmethod

Return type:

List

GET_ALL_USERS - @classmethod

Return type:

List

GET_BY_ID_AND_CHECK - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

User

GET_BY_ID_OR_NONE - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

Optional

GET_OR_IMPORT_USER_INFO - @classmethod

Get the user info from the database. If he doesn"t exist, get it from the space (this might import a user that is not active in the lab)

:raises BadRequestException: description

Parameters:

Name	Type	Default value	Description
user_id	`str`		_description_

Return type:

User

GET_SYSUSER - @classmethod

GET_USER_BY_EMAIL - @classmethod

Parameters:

Name	Type	Default value	Description
email	`str`

Return type:

gws_core.user.user.User | None

GET_USER_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

gws_core.user.user.User | None

SET_USER_ACTIVE - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`
is_active	`bool`

Return type:

User

SMART_SEARCH_BY_NAME - @classmethod

Parameters:

Name	Type	Default value	Description
name	`str`
page	`int`	0
number_of_items_per_page	`int`	20

Return type:

Paginator

SYNCHRONIZE_ALL_SPACE_USERS - @classmethod

USER_EXISTS - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`

Return type:

bool