ClientControllerMetadata - метод |
Выполняет инициализацию данных по сессии и возвращает серверную метаинформацию при запуске web-клиента.
Возвращает сериализованную в JSON строку с метаинформацией и настройками пользователя.
Некоторые типы подобъектов внутри JSON возвращаются с отдельными ключами $type.
Пространство имён:
Tessa.Web.Client.Controllers
Сборка:
Tessa.Web.Client (в Tessa.Web.Client.dll) Версия: 3.5.0.19
Синтаксис [HttpGetAttribute("meta")]
[SessionMethodAttribute(UserAccessLevel.Regular)]
public Task<IActionResult> Metadata(
bool? withoutCards,
bool? justCards,
string cardId,
int? cachedVersion,
string userSettingsLastUpdate,
CancellationToken cancellationToken = default
)
<HttpGetAttribute("meta")>
<SessionMethodAttribute(UserAccessLevel.Regular)>
Public Function Metadata (
withoutCards As Boolean?,
justCards As Boolean?,
cardId As String,
cachedVersion As Integer?,
userSettingsLastUpdate As String,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IActionResult)
public:
[HttpGetAttribute(L"meta")]
[SessionMethodAttribute(UserAccessLevel::Regular)]
Task<IActionResult^>^ Metadata(
Nullable<bool> withoutCards,
Nullable<bool> justCards,
String^ cardId,
Nullable<int> cachedVersion,
String^ userSettingsLastUpdate,
CancellationToken cancellationToken = CancellationToken()
)
[<HttpGetAttribute("meta")>]
[<SessionMethodAttribute(UserAccessLevel.Regular)>]
member Metadata :
withoutCards : Nullable<bool> *
justCards : Nullable<bool> *
cardId : string *
cachedVersion : Nullable<int> *
userSettingsLastUpdate : string *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IActionResult>
Параметры
- withoutCards
- Тип: SystemNullableBoolean
Не возвращать метаинформацию по карточкам. - justCards
- Тип: SystemNullableBoolean
Возвращать только метаинформацию по карточкам и не возвращать никакую другую метаинформацию или настройки. - cardId
- Тип: SystemString
Не используется. - cachedVersion
- Тип: SystemNullableInt32
Версия метаинформации, которая добавлена в кэш на клиенте. Если версия конфигурации на сервере равна версии на клиенте,
то загружается ограниченный набор настроек, не связанных с серверной метаинформацией (например. настройки текущего пользователя).
- userSettingsLastUpdate
- Тип: SystemString
Временная метка данных настроек пользовтеля. - cancellationToken (Optional)
- Тип: System.ThreadingCancellationToken
Объект, посредством которого можно отменить асинхронную задачу.
Возвращаемое значение
Тип:
TaskIActionResult
Сериализованная в JSON строка с метаинформацией и настройками пользователя.
Некоторые типы подобъектов внутри JSON возвращаются с отдельными ключами
$type.
См. также