https://community.telligent.com/community/14/w/api-documentation/77147/url-in-process-api-service<p><span>Developing on Verint Community? Use the API documentation as a reference for all supported interactions with Verint Community.</span></p>en-US14.0.0.684 14https://community.telligent.com/community/14/w/api-documentation/77147/url-in-process-api-serviceWed, 14 May 2025 16:50:52 GMTc62bfeb0-7fd4-46ce-845b-1e9d31b2c95dVerint | Telligent Communityhttps://community.telligent.com/community/14/w/api-documentation/77147/url-in-process-api-service#commentsCurrent Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 16:50:52<br /> <hr class="generated-documentation-start" style="border-width:0;" /><div class="documentation"><p>This service is available via <code>Telligent.Evolution.Extensibility.Apis.Get&lt;Telligent.Evolution.Extensibility.Api.Version1.IUrl&gt;()</code></p><div class="documentation-members properties"><h2>Properties</h2><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>CurrentContext</td><td><code>[[PageContext In-Process API Supplementary Type|PageContext]]</code></td><td>Exposes the current contextual information about the incoming url</td><td></td><td></td></tr></tbody></table></div><div class="documentation-members methods"><h2>Methods</h2><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> Absolute(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> Adjust(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url, <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> queryStringAdjustment = null, <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> targetAdjustment = null); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr><tr><td>queryStringAdjustment</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Query String Adjustment</td><td>Optional</td><td></td><td></td></tr><tr><td>targetAdjustment</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Target Adjustment</td><td>Optional</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> ApplicationEscape(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> ApplicationUnescape(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> BuildUrl(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> urlName, <a href="https://learn.microsoft.com/en-us/dotnet/api/system.int32?view=net-9.0">int</a> groupId, <a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2?view=net-9.0">IDictionary</a>&lt;<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>,<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>&gt; parameters = null); </h3><p>Generates a relative url based on the given parameters including the group path</p><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>urlName</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url Name</td><td>Required</td><td></td><td></td></tr><tr><td>groupId</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.int32?view=net-9.0">int</a></code></td><td>Group Id</td><td>Required</td><td></td><td></td></tr><tr><td>parameters</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2?view=net-9.0">IDictionary</a>&lt;<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>,<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>&gt;</code></td><td>Parameters</td><td>Optional</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> BuildUrl(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> urlName, <a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2?view=net-9.0">IDictionary</a>&lt;<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>,<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>&gt; parameters = null); </h3><p>Generates a relative url based on the given parameters</p><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>urlName</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url Name</td><td>Required</td><td></td><td></td></tr><tr><td>parameters</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.idictionary-2?view=net-9.0">IDictionary</a>&lt;<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>,<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a>&gt;</code></td><td>Parameters</td><td>Optional</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> ConvertQueryStringToHash(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> Decode(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> text); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> DecodeFileComponent(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> text); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> DecodePathComponent(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> text); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> Encode(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> text); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> EncodeFileComponent(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> text); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> EncodePathComponent(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> text); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.boolean?view=net-9.0">bool</a> IsSafe(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.boolean?view=net-9.0">bool</a></code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.boolean?view=net-9.0">bool</a> IsSafe(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.guid?view=net-9.0">Guid</a> contentTypeId, <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>contentTypeId</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.guid?view=net-9.0">Guid</a></code></td><td>Content Type Id</td><td>Required</td><td></td><td></td></tr><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.boolean?view=net-9.0">bool</a></code></p><h3> SafeUrlValidation IsSafe(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url, SafeUrlOptions options); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr><tr><td>options</td><td><code>[[SafeUrlOptions In-Process API Supplementary Type|SafeUrlOptions]]</code></td><td>Options</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code>[[SafeUrlValidation In-Process API Supplementary Type|SafeUrlValidation]]</code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> MakeQueryString(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.specialized.namevaluecollection?view=net-9.0">NameValueCollection</a> queryStringValues); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>queryStringValues</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.specialized.namevaluecollection?view=net-9.0">NameValueCollection</a></code></td><td>Query String Values</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></p><h3> PageContext ParsePageContext(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><p>Extracts contextual information for a given local Community URL</p><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code>[[PageContext In-Process API Supplementary Type|PageContext]]</code></p><h3> <a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.specialized.namevaluecollection?view=net-9.0">NameValueCollection</a> ParseQueryString(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> queryString); </h3><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>queryString</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Query String</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.collections.specialized.namevaluecollection?view=net-9.0">NameValueCollection</a></code></p><h3> ApiList&lt;UrlEntity&gt; ParseUrl(<a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a> url); </h3><p>Extracts contextual information for a given URL</p><h4>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code><a href="https://learn.microsoft.com/en-us/dotnet/api/system.string?view=net-9.0">string</a></code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4>Return Type</h4><p><code>[[ApiList(T) In-Process API Event Argument|ApiList]]&lt;[[UrlEntity In-Process API Supplementary Type|UrlEntity]]&gt;</code></p></div></div><hr class="generated-documentation-end" style="border-width:0;" /><div style="clear:both;"></div>