Skip to content

Class: ContextService ​

Overview ​

The Context module provides methods for managing session context and data persistence. It allows you to store and retrieve data across session operations.

Table of contents ​

Methods ​

Methods ​

clear ​

▸ clear(contextId, timeout?, pollInterval?): Promise<ClearContextResult>

Parameters ​

NameTypeDefault value
contextIdstringundefined
timeoutnumber60
pollIntervalnumber2

Returns ​

Promise<ClearContextResult>


clearAsync ​

▸ clearAsync(contextId): Promise<ClearContextResult>

Parameters ​

NameType
contextIdstring

Returns ​

Promise<ClearContextResult>


create ​

▸ create(name): Promise<ContextResult>

Parameters ​

NameType
namestring

Returns ​

Promise<ContextResult>


delete ​

▸ delete(context): Promise<OperationResult>

Parameters ​

NameType
contextContext

Returns ​

Promise<OperationResult>


deleteFile ​

▸ deleteFile(contextId, filePath): Promise<OperationResult>

Parameters ​

NameType
contextIdstring
filePathstring

Returns ​

Promise<OperationResult>


get ​

▸ get(name?, create?, loginRegionId?, contextId?): Promise<ContextResult>

Parameters ​

NameTypeDefault value
name?stringundefined
createbooleanfalse
loginRegionId?stringundefined
contextId?stringundefined

Returns ​

Promise<ContextResult>

getFileDownloadUrl ​

▸ getFileDownloadUrl(contextId, filePath): Promise<FileUrlResult>

Parameters ​

NameType
contextIdstring
filePathstring

Returns ​

Promise<FileUrlResult>


getFileUploadUrl ​

▸ getFileUploadUrl(contextId, filePath): Promise<FileUrlResult>

Parameters ​

NameType
contextIdstring
filePathstring

Returns ​

Promise<FileUrlResult>


list ​

▸ list(params?): Promise<ContextListResult>

Parameters ​

NameType
params?ContextListParams

Returns ​

Promise<ContextListResult>


listFiles ​

▸ listFiles(contextId, parentFolderPath?, pageNumber?, pageSize?): Promise<ContextFileListResult>

Parameters ​

NameTypeDefault value
contextIdstringundefined
parentFolderPath?stringundefined
pageNumbernumber1
pageSizenumber50

Returns ​

Promise<ContextFileListResult>


toJSON ​

▸ toJSON(): Record<string, unknown>

Returns ​

Record<string, unknown>


update ​

▸ update(context): Promise<OperationResult>

Parameters ​

NameType
contextContext

Returns ​

Promise<OperationResult>