ClientControllerGetWallpaperAsync - метод |
Возвращает файл фонового изображения по заданному имени.
Пространство имён:
Tessa.Web.Client.Controllers
Сборка:
Tessa.Web.Client (в Tessa.Web.Client.dll) Версия: 3.5.0.19
Синтаксис [HttpGetAttribute("wallpapers/{name}")]
[SessionMethodAttribute(UserAccessLevel.Regular)]
public Task<IActionResult> GetWallpaperAsync(
string name,
GetWallpaperMode mode = GetWallpaperMode.None,
CancellationToken cancellationToken = default
)
<HttpGetAttribute("wallpapers/{name}")>
<SessionMethodAttribute(UserAccessLevel.Regular)>
Public Function GetWallpaperAsync (
name As String,
Optional mode As GetWallpaperMode = GetWallpaperMode.None,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IActionResult)
public:
[HttpGetAttribute(L"wallpapers/{name}")]
[SessionMethodAttribute(UserAccessLevel::Regular)]
Task<IActionResult^>^ GetWallpaperAsync(
String^ name,
GetWallpaperMode mode = GetWallpaperMode::None,
CancellationToken cancellationToken = CancellationToken()
)
[<HttpGetAttribute("wallpapers/{name}")>]
[<SessionMethodAttribute(UserAccessLevel.Regular)>]
member GetWallpaperAsync :
name : string *
?mode : GetWallpaperMode *
?cancellationToken : CancellationToken
(* Defaults:
let _mode = defaultArg mode GetWallpaperMode.None
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IActionResult>
Параметры
- name
- Тип: SystemString
Имя файла с фоновым изображением. Если совпадает с именем файла, прикладываемого к карточке
(настройка WebWallpaper в серверном app.json), то возвращается файл, приложенный к карточке сотрудника (нестандартное изображение, выбранное пользователем).
- mode (Optional)
- Тип: Tessa.Web.Client.ModelsGetWallpaperMode
Признак, определяющий как должен поменяться фон. - cancellationToken (Optional)
- Тип: System.ThreadingCancellationToken
Объект, посредством которого можно отменить асинхронную задачу.
Возвращаемое значение
Тип:
TaskIActionResultФайл фонового изображения.
Исключения См. также