Appearance
Class: ContextService
📖 Related Tutorial
- Context Usage Guide - Learn about context management and data persistence
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
| Name | Type | Default value |
|---|---|---|
contextId | string | undefined |
timeout | number | 60 |
pollInterval | number | 2 |
Returns
Promise<ClearContextResult>
clearAsync
▸ clearAsync(contextId): Promise<ClearContextResult>
Parameters
| Name | Type |
|---|---|
contextId | string |
Returns
Promise<ClearContextResult>
create
▸ create(name): Promise<ContextResult>
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Promise<ContextResult>
delete
▸ delete(context): Promise<OperationResult>
Parameters
| Name | Type |
|---|---|
context | Context |
Returns
Promise<OperationResult>
deleteFile
▸ deleteFile(contextId, filePath): Promise<OperationResult>
Parameters
| Name | Type |
|---|---|
contextId | string |
filePath | string |
Returns
Promise<OperationResult>
get
▸ get(name?, create?, loginRegionId?, contextId?): Promise<ContextResult>
Parameters
| Name | Type | Default value |
|---|---|---|
name? | string | undefined |
create | boolean | false |
loginRegionId? | string | undefined |
contextId? | string | undefined |
Returns
Promise<ContextResult>
getFileDownloadUrl
▸ getFileDownloadUrl(contextId, filePath): Promise<FileUrlResult>
Parameters
| Name | Type |
|---|---|
contextId | string |
filePath | string |
Returns
Promise<FileUrlResult>
getFileUploadUrl
▸ getFileUploadUrl(contextId, filePath): Promise<FileUrlResult>
Parameters
| Name | Type |
|---|---|
contextId | string |
filePath | string |
Returns
Promise<FileUrlResult>
list
▸ list(params?): Promise<ContextListResult>
Parameters
| Name | Type |
|---|---|
params? | ContextListParams |
Returns
Promise<ContextListResult>
listFiles
▸ listFiles(contextId, parentFolderPath?, pageNumber?, pageSize?): Promise<ContextFileListResult>
Parameters
| Name | Type | Default value |
|---|---|---|
contextId | string | undefined |
parentFolderPath? | string | undefined |
pageNumber | number | 1 |
pageSize | number | 50 |
Returns
Promise<ContextFileListResult>
toJSON
▸ toJSON(): Record<string, unknown>
Returns
Record<string, unknown>
update
▸ update(context): Promise<OperationResult>
Parameters
| Name | Type |
|---|---|
context | Context |
Returns
Promise<OperationResult>