Asynchronously adds recording tags.

Note: This method is supported for IC Server version 2016 R3 and beyond.

Namespace: ININ.IceLib.QualityManagement
Assembly: ININ.IceLib.QualityManagement (in ININ.IceLib.QualityManagement.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void AddRecordingTagsAsync(
	string recordingId,
	IEnumerable<string> tags,
	EventHandler<AsyncCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub AddRecordingTagsAsync ( _
	recordingId As String, _
	tags As IEnumerable(Of String), _
	completedCallback As EventHandler(Of AsyncCompletedEventArgs), _
	userState As Object _
)

Parameters

recordingId
Type: System..::..String
The recording ID.
tags
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'String>)>)>
The recording tags to be added to the recording.
completedCallback
Type: System..::..EventHandler<(Of <(<'AsyncCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An object that contains state information for this request.

Remarks

Tags are case insensitive within Recorder Server, so a tag of "test" or "Test" will be considered the same tag. If multiple tags with the same value are added to a recording, only the first tag will be added and the rest will be ignored as duplicates.

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs - derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionrecordingId is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionrecordingId length is zero.
System..::..ArgumentNullExceptiontags is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptiontags is empty.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

Version Information

Supported for IC Server version 2016 R3 and beyond.

See Also