Click or drag to resize

SessionSetSessionInfo Method

Edit user's current session. All null values will not be changed.

Namespace:  Koopman.CheckPoint
Assembly:  CheckPoint.NET (in CheckPoint.NET.dll) Version: 0.5.1
Syntax
C#
public Task<SessionInfo> SetSessionInfo(
	string name = null,
	string description = null,
	string[] tags = null,
	Nullable<Colors> color = null,
	string comments = null,
	Ignore ignore = Ignore.No,
	CancellationToken cancellationToken = null
)
Request Example View Source

Parameters

name (Optional)
Type: SystemString
The session name.
description (Optional)
Type: SystemString
The session description.
tags (Optional)
Type: SystemString
The session tags.
color (Optional)
Type: SystemNullableColors
The session color.
comments (Optional)
Type: SystemString
The session comments.
ignore (Optional)
Type: Koopman.CheckPointIgnore
Weather warnings or errors should be ignored
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskSessionInfo
A task that represents the asynchronous operation. The task result contains the Updated SessionInfo
See Also