ReportingService2006.FireEvent Method

Article
12/03/2008

Raises an event based on the supplied parameters.

Namespace: ReportService2006
Assembly: ReportService2006 (in reportservice2006.dll)

Syntax

'Declaration
Public Sub FireEvent ( _
    EventType As String, _
    EventData As String, _
    Site As String _
)

public void FireEvent (
    string EventType,
    string EventData,
    string Site
)

public:
void FireEvent (
    String^ EventType, 
    String^ EventData, 
    String^ Site
)

public void FireEvent (
    String EventType, 
    String EventData, 
    String Site
)

public function FireEvent (
    EventType : String, 
    EventData : String, 
    Site : String
)

Parameters

EventType
The name of the event.

EventData
The data that is associated with the event.

Site
The fully qualified URL for the SharePoint site.

Remarks

The EventType parameter is matched against the known set of events that are defined in the report server configuration file. If the event is not in the report server configuration file, a SOAP exception is thrown with an error code of rsUnknownEventType. The FireEvent method only supports the TimedSubscription event type.

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

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)
    {
        ReportingService2006 rs = new ReportingService2006();
        rs.Url = "http://<Server Name>" +
            "/_vti_bin/ReportServer/ReportService2006.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);
        }
    }
}

Imports System
Imports System.IO
Imports System.Text
Imports System.Web.Services
Imports System.Web.Services.Protocols

Class Sample

    Public Shared Sub Main()

        Dim rs As New ReportingService2006()
        rs.Url = "http://<Server Name>" + _
            "/_vti_bin/ReportServer/ReportService2006.asmx"
        rs.Credentials = _
            System.Net.CredentialCache.DefaultCredentials

        Dim site As String = "http://<Server Name>"

        ' Get the subscriptions
        Dim subs As Subscription() = _
            rs.ListAllSubscriptions(site)

        Try
            If Not (subs Is Nothing) Then
                ' Fire the first subscription in the list
                rs.FireEvent("TimedSubscription", subs(0).SubscriptionID, site)
                Console.WriteLine("Event fired.")
            End If
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try

    End Sub

End Class

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional with Service Pack 2 (SP2), Windows 2000 Professional, Windows 2000 Advanced Server, Windows XP Home Edition, For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005., Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

Share via