ClientBase.GetComponentInfo Method

ClientBase GetComponentInfo Method

Gets component information for the specified template.

Namespace: HotDocs.Sdk.Cloud
Assembly: HotDocs.Sdk.Cloud (in HotDocs.Sdk.Cloud.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public ComponentInfo GetComponentInfo(
	Template template,
	bool includeDialogs = false,
	string billingRef = null
)

public ComponentInfo GetComponentInfo(
	Template template,
	bool includeDialogs = false,
	string billingRef = null
)

includeDialogs (Optional): Type: System Boolean
This indicates whether or not the returned data should include information about dialogs and their contents.

billingRef (Optional): Type: System String
This parameter lets you specify information that will be included in usage logs for this call. For example, you can use a string to uniquely identify the end user that initiated the request and/or the context in which the call was made. When you review usage logs, you can then see which end users initiated each request. That information could then be used to pass costs on to those end users if desired.

Type: ComponentInfo
A ComponentInfo object containing information about the requested components.