Publishes the client template to the specified role.
Namespace: ININ.IceLib.ConfigurationAssembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public static ReadOnlyCollection<ClientTemplatePublishResult> PublishClientTemplate( ConfigurationManager configurationManager, ConfigurationId clientTemplateId, string roleId, string applicationId ) |
Visual Basic |
---|
Public Shared Function PublishClientTemplate ( _ configurationManager As ConfigurationManager, _ clientTemplateId As ConfigurationId, _ roleId As 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.
- roleId
- Type: System..::..String
The role ID.
- 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 role value can be retrieved
from the Id portion of RoleConfiguration
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
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | roleId, or applicationId is Empty. |
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.
For 4.0, supported for IC Server version 4.0 SU 3 and beyond.