ReportingService2005.SetSubscriptionProperties Méthode

Définition

Espace de noms:

ReportService2005

Assembly:

ReportService2005.dll

Définit les propriétés d'un abonnement.

public:
 void SetSubscriptionProperties(System::String ^ SubscriptionID, ReportService2005::ExtensionSettings ^ ExtensionSettings, System::String ^ Description, System::String ^ EventType, System::String ^ MatchData, cli::array <ReportService2005::ParameterValue ^> ^ Parameters);

public void SetSubscriptionProperties (string SubscriptionID, ReportService2005.ExtensionSettings ExtensionSettings, string Description, string EventType, string MatchData, ReportService2005.ParameterValue[] Parameters);

member this.SetSubscriptionProperties : string * ReportService2005.ExtensionSettings * string * string * string * ReportService2005.ParameterValue[] -> unit

Public Sub SetSubscriptionProperties (SubscriptionID As String, ExtensionSettings As ExtensionSettings, Description As String, EventType As String, MatchData As String, Parameters As ParameterValue())

Paramètres

SubscriptionID

String

ID de l'abonnement.

ExtensionSettings

ExtensionSettings

Objet ExtensionSettings qui contient une liste de paramètres spécifiques à l'extension de remise.

Description

String

Description explicite affichée pour les utilisateurs.

EventType

String

Type d'événement qui a déclenché l'abonnement.

MatchData

String

Données associées au type d'événement spécifié. Ces données sont utilisées par une extension de traitement des événements pour faire correspondre l’abonnement à un événement déclenché.

Parameters

ParameterValue[]

Tableau d'objets ParameterValue qui contient une liste de paramètres pour le rapport.

Remarques

Le tableau suivant présente les informations relatives aux en-têtes et aux autorisations sur cette opération.

En-têtes SOAP	(In) BatchHeaderValue (Out) ServerInfoHeaderValue
Autorisations requises	UpdateAnySubscription OR (UpdateSubscription ET l’utilisateur est le propriétaire du rapport et l’abonnement est un abonnement chrono timed)

La valeur du EventType paramètre doit correspondre à une extension de traitement des événements configurée sur le serveur de rapports. Si le type d’événement n’est pas géré par une extension de traitement des événements, une exception SOAP est levée avec le code rsInvalidEventd’erreur . Le type d’événement doit être géré par une extension de traitement des événements qui crée des notifications. Lorsqu’une valeur pour le EventType paramètre est reçue, l’extension de traitement des événements est interrogée pour déterminer si l’événement crée des notifications. Si ce n’est pas le cas, une exception SOAP est levée avec le code rsEventNonSubscribeabled’erreur .

La valeur du MatchData paramètre dépend du type d’événement. Si l’événement est un événement TimedSubscription , un ScheduleDefinition objet est requis comme MatchData paramètre. Vous devez d’abord sérialiser l’objet ScheduleDefinition au format XML afin de le passer en tant que valeur de chaîne et de créer un abonnement en fonction de la planification. La structure XML peut ressembler à celle de l’exemple suivant :

<ScheduleDefinition>  
   <WeeklyRecurrence>  
      <StartDateTime>2003-02-24T09:00:00-08:00</StartDateTime>  
      <WeeksInterval>1</WeeksInterval>  
      <DaysOfWeek>  
         <Monday>True</Monday>  
         </DaysOfWeek>  
   </WeeklyRecurrence>  
</ScheduleDefinition>  

La valeur de l’élément StartDateTime lorsqu’il est passé en tant que chaîne XML doit correspondre au format de date ISO 8601. Cette norme internationale de date et d’heure est au format étendu CCYY-MM-DDThh:mm:ss+/-Z où « CC » représente le siècle, « YY » l’année, « MM » le mois et « JJ » le jour. La lettre « T » est le séparateur de date et d’heure et « hh », « mm », « ss » représentent respectivement l’heure, la minute et la seconde. Cette représentation peut être immédiatement suivie d’un « Z » pour indiquer le temps universel coordonné (UTC). Pour indiquer le fuseau horaire, représenté comme la différence entre l’heure locale et l’heure universelle coordonnée, « Z » est précédé d’un signe « + » ou « - », suivi de la différence par rapport à UTC représentée par hh:mm.

Si la définition de planification d’un TimedSubscription est une planification partagée, vous devez passer l’ID de planification de la planification partagée comme MatchData paramètre. L’ID de planification est transmis en tant que String, par exemple, « 4608ac1b-fc75-4149-9e15-5a8b5781b843 ». L’ID de planification peut être obtenu en appelant la ListSchedules méthode .

Si l’événement est un abonnement instantané mise à jour, définissez MatchData le paramètre sur null (Nothing en Visual Basic).