Publishes the client template to the specified user IDs.

Namespace: ININ.IceLib.Configuration
Assembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: 0.0.0.0 (21.2.0.218)

Syntax

C#
public static ReadOnlyCollection<ClientTemplatePublishResult> PublishClientTemplate(
	ConfigurationManager configurationManager,
	ConfigurationId clientTemplateId,
	IEnumerable<string> userIds,
	string applicationId
)
Visual Basic
Public Shared Function PublishClientTemplate ( _
	configurationManager As ConfigurationManager, _
	clientTemplateId As ConfigurationId, _
	userIds As IEnumerable(Of String), _
	applicationId As String _
) As ReadOnlyCollection(Of ClientTemplatePublishResult)

Parameters

configurationManager
Type: ININ.IceLib.Configuration..::..ConfigurationManager
The configuration manager.
clientTemplateId
Type: ININ.IceLib.Configuration..::..ConfigurationId
The client template ID.
userIds
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'String>)>)>
The user IDs.
applicationId
Type: System..::..String
The application ID.

Return Value

A ReadOnlyCollection<(Of <(<'T>)>)> of ClientTemplatePublishResult objects with the results of the publish operation.

Remarks

Valid clientTemplateId values can be retrieved from the ConfigurationId property of ClientTemplateConfiguration. The userIds value can be retrieved from the Id portion of UserConfiguration, or UserId. The applicationId can be retrieved from the ApplicationName portion of the return value from GetSessionSettings()()()(). In order to publish client templates, the logged on user must have the CanPublishClientTemplates right.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionconfigurationManager, clientTemplateId, or applicationId is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionOne of the values in userIds is Empty, or applicationId is Empty.
System..::..InvalidOperationExceptionuserIds is nullNothingnullptra null reference (Nothing in Visual Basic).

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 SU 3 and beyond.

See Also