Export (0) Print
Expand All

ReportingService2010.FireEvent Method (String, String, String)

 

Applies To: SQL Server 2016 Preview

Raises an event based on the supplied parameters.

Namespace:   ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/FireEvent", 
	RequestNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
	ResponseNamespace = "http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
	Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapHeaderAttribute("TrustedUserHeaderValue")]
public void FireEvent(
	string EventType,
	string EventData,
	string SiteUrl
)

Parameters

EventType
Type: System.String

The name of the event.

EventData
Type: System.String

The data that is associated with the event.

SiteUrl
Type: System.String

The fully qualified URL for the SharePoint site.

Specify null (Nothing in Visual Basic) when invoking this method in Native mode.

The table below shows header and permissions information on this operation.

SOAP Header Usage

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

Native Mode Required Permissions

GenerateEvents (System)

SharePoint Mode Required Permissions

ManageWeb

This method throws an rsUnsupportedParameterForModeException exception if a non-null value is specified for the SiteUrl parameter in Native mode.

The EventType parameter is matched against the known set of events that are defined in the report server configuration file (rsreportserver.config). If the event is not in the report server configuration file, a SOAP exception is thrown with an error code of rsUnknownEventType. This method supports the TimedSubscription and RefreshCache event types.

If EventType is TimedSubscription, specify the subscription ID in EventData, which is returned by CreateSubscription or CreateDataDrivenSubscription or CreateDataDrivenSubscription. If EventType is RefreshCache, specify the cache refresh plan ID in EventData, which is returned by CreateCacheRefreshPlan.

The FireEvent method does not verify or validate the data supplied in the EventData parameter. Any string value is valid including an empty string.

Legacy Code Example

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

class Sample
{
    static void Main(string[] args)
    {
        ReportingService2010 rs = new ReportingService2010();
        rs.Url = "http://<Server Name>" +
            "/_vti_bin/ReportServer/ReportService2010.asmx";
        rs.Credentials = 
            System.Net.CredentialCache.DefaultCredentials;

        string site = "http://<Server Name>";

        // Get the subscriptions
        Subscription[] subs = 
            rs.ListMySubscriptions(site);

        try
        {
            if (subs != null)
            {
                // Fire the first subscription in the list
                rs.FireEvent("TimedSubscription", 
                    subs[0].SubscriptionID, site);
                Console.WriteLine("Event fired.");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}
Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft