Share via

AnalyticsTenantConfig.RegisterEventType method

  • Article

Registers an event for use by a tenant.

Namespace:  Microsoft.Office.Server.Search.Analytics
Assembly:  Microsoft.Office.Server.Search.Applications (in Microsoft.Office.Server.Search.Applications.dll)

Syntax

'Declaration
Public Function RegisterEventType ( _
    customEventTypeId As Guid, _
    eventName As String, _
    appName As String _
) As AnalyticsEventTypeDefinition
'Usage
Dim instance As AnalyticsTenantConfig
Dim customEventTypeId As Guid
Dim eventName As String
Dim appName As String
Dim returnValue As AnalyticsEventTypeDefinition

returnValue = instance.RegisterEventType(customEventTypeId, _
    eventName, appName)

public AnalyticsEventTypeDefinition RegisterEventType(
    Guid customEventTypeId,
    string eventName,
    string appName
)

Parameters

  • customEventTypeId
    Type: System.Guid

    The application ID to use to record the event.

Return value

Type: Microsoft.Office.Server.Search.Analytics.AnalyticsEventTypeDefinition
The analytics event type definition.

Remarks

There are a fixed number of custom analytics event type definitions available for use by applications for a particular tenant. This API allocates one of those definitions for use such that they can be logged via the application event type ID.

Note

eventName and appName support $Resources tokens.

See also

Reference

AnalyticsTenantConfig class

AnalyticsTenantConfig members

Microsoft.Office.Server.Search.Analytics namespace