Share via


Hold.NominateEdiscoverySuscriptionHub Method

Nominates the specified site as the eDiscovery hub of the site subscription.

Namespace:  Microsoft.Office.RecordsManagement.Holds
Assembly:  Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)

Syntax

'Declaration
Public Shared Sub NominateEdiscoverySuscriptionHub ( _
    site As SPSite _
)
'Usage
Dim site As SPSiteHold.NominateEdiscoverySuscriptionHub(site)
public static void NominateEdiscoverySuscriptionHub(
    SPSite site
)

Parameters

Exceptions

Exception Condition
ArgumentNullException

Site is a null reference (Nothing in Visual Basic).

ArgumentException

Site does not belong to a site subscription.

Remarks

This method does the following:1. Check that the site subscription actually exists.(without that you cannot nominate a hub). 2. Check if there is an existing hub (presumably which was nominated earlier.) 3. If there is an existing hub then we remove its nomination.4. Now in the Site Subscriptions Settings make and entry for the hub's site id. 5. On the Site's properties cache the fact that it is the hub.

See Also

Reference

Hold Class

Hold Members

Microsoft.Office.RecordsManagement.Holds Namespace