Partager via

Vue d’ensemble du modèle objet mobile SharePoint

  • Article

Découvrez les nouvelles classes publiques dans le modèle objet serveur SharePoint et le modèle objet client Silverlight qui sont utilisées pour développer des solutions intégrées pour SharePoint et Windows Phone 7.5.

Modèle d'objet client pour Silverlight mobile

Toutes les classes dans cette section se trouvent dans l'espace de noms Microsoft.SharePoint.Client. Outre les API de cette section, la plupart des classes et des membres dans la section modèle d'objet serveur SharePoint mobilité peuvent également être appelée dans le modèle objet client. Pour les classes qui commencent par « SP », le nom du modèle objet client a le « SP » supprimée. Dans les autres cas, le nom du modèle objet client est spécifié. Les noms de membres sont les mêmes dans le modèle d'objet client à l'exception de l'emplacement spécifié dans le cas contraire.

Importante

Les personnalisations basées sur JSLink (rendu côté client) ne sont pas prises en charge dans les expériences modernes. Cela inclut les bibliothèques et les listes modernes, y compris la prise en charge de JSLink dans les composants WebPart d’affichage de liste de pages modernes. Le rendu côté client est pris en charge dans les expériences classiques dans SharePoint Online ou en local.

AlternateUrl classe

Représente une URL de remplacement pour une application web et la zone à laquelle elle s'applique.


public class AlternateUrl

Propriétés

Uri (lecture seule)

Obtient l'URI de l'URL de substitution.

public String Uri

UrlZone (lecture seule)

Obtient la zone de l'URL de substitution.

public UrlZone UrlZone

La classe UrlZone est la version du modèle objet client de la classe SPUrlZone dans le modèle objet serveur. Pour plus d’informations à ce sujet, consultez le Kit de développement logiciel (SDK) SharePoint 2010.

Classe de AuthenticationCompletedEventArgs

Fournit des données relatives à un événement AuthenticationCompleted.

public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs

Constructeurs

Initialise une nouvelle instance de la classe AuthenticationCompletedEventArgs.


public AuthenticationCompletedEventArgs(Exception error, bool canceled, HttpStatusCode userState)

Paramètres

  • error est l'objet Exception s'il y a une exception lors de la tentative d'authentification.

  • canceled a la valeur true si la tentative d'authentification a été annulée avant qu'il pourrait réussissent ou échouent.

  • userState est le HttpStatusCode renvoyé par le serveur.

Propriétés

HttpStatusCode (lecture seule)

Obtient l'état renvoyé par le serveur après une tentative d'authentification.

public HttpStatusCode HttpStatusCode

AuthenticationStatus enum

Spécifie l'état actuel d'une tentative d'authentification.

  • NotStarted

  • InProgress

  • CompletedSuccess

  • CompletedException

Classe d'authentificateur

Fournit des méthodes permettant d'authentifier un utilisateur sur un site Web SharePoint.

public class Authenticator : ICredentials

Constructeurs

Initialise une nouvelle instance de la classe.

public Authenticator()

public Authenticator(Uri uagServerUrl)

Paramètres

uagServerUrl est l'URL absolue d'un serveur United Access Gateway (UAG).


public Authenticator(string userName, string password)

Paramètres

userName est le nom pour les informations d'identification.

password est le mot de passe pour les informations d'identification.

public Authenticator(string userName, string password, string domain)

Paramètres

userName est le nom pour les informations d'identification.

password est le mot de passe pour les informations d'identification.

domain est le nom du domaine ou l'ordinateur où les informations d'identification sont vérifiées, généralement le domaine de l'utilisateur actuel.

public Authenticator(string userName, string password, Uri uagServerUrl)

Paramètres

userName est le nom pour les informations d'identification.

password est le mot de passe pour les informations d'identification.

uagServerUrl est l'URL absolue d'un serveur United Access Gateway (UAG).

public Authenticator(string userName, string password, string domain, Uri uagServerUrl)

Paramètres

userName est le nom pour les informations d'identification.

password est le mot de passe pour les informations d'identification.

domain est le nom du domaine ou l'ordinateur où les informations d'identification sont vérifiées, généralement le domaine de l'utilisateur actuel.

uagServerUrl est l'URL absolue d'un serveur United Access Gateway (UAG).

Méthodes

ClearAllApplicationSettings

Efface tous les cookies, les informations d'identification et les paramètres UAG à partir du cache.

public static void ClearAllApplicationSettings

ClearAllCookies

Efface tous les cookies et affecte à la propriété Status de tous les objets AuthenticatorNotStarted.

public static void ClearAllCookies()

ClearAllCredentials

Efface toutes les informations d'identification à partir du cache et affecte à la propriété Status de tous les objets AuthenticatorNotStarted.

public static void ClearAllCredentials()

GetCredential

Obtient un objet d'identification pour le type d'authentification et uri spécifié.

public NetworkCredential GetCredential(Uri uri, string authType)

Paramètres

  • uri est l'URI, y compris les ports, pour lequel le client fournit des informations d'authentification.

  • authType est le type d'authentification demandé.

Cette méthode est utilisée uniquement pour l'authentification anonyme. Si authType n’est pas « De base », un objet vide est retourné. Pour plus d'informations sur la classe NetworkCredential, voir la Classe NetworkCredential.

IsRequestUnauthorized

Renvoie la valeur true si la demande d'autorisation a échoué en raison d'un cookie non valide ou les informations d'identification.

public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEventArgs)

Propriétés

AllowSmartRouting

Obtient ou définit un indicateur qui signale si le routage dynamique est activé.

public bool AllowSmartRouting

Lorsque le routage dynamique est activé, l'objet Authenticator essaie de se connecter au serveur qui exécute SharePoint et le serveur UAG et utilise selon la situation qui répond en premier comme canal de communication. S'il n'existe aucun serveur UAG, cette propriété est ignorée. La valeur par défaut est true. Si la valeur false, le serveur UAG est toujours utilisée.

AuthenticatorMode

Obtient ou définit le mode d'authentification.

public ClientAuthenticationMode AuthenticationMode

Pour plus d'informations sur l'énumération ClientAuthenticationMode, voir plus loin dans ce document.

CookieCachingEnabled

Obtient ou définit un indicateur qui signale si les cookies sont mis en cache.

public bool CookieCachingEnabled

Si vous activez la mise en cache des cookies, considérez que les cookies expirent à un moment donné. Si elles ont expiré lorsque ExecuteQueryAsync est appelée, puis elle échoue et le rappel de l'échec s'exécute. En conséquence, si vous définissez cette propriété sur true, vous devez ajouter le code pour le rappel d'échec qui efface le cache si cela se produit. Voici un exemple, lesquelles execQueryArgs est du type ClientRequestFailedEventArgs passé dans le rappel d'échec de ExecuteQueryAsync.

if (Authenticator.IsRequestUnauthorized(execQueryArgs))
{
    (sender as Authenticator).ClearCookies();
}

CredentialCachingEnabled

Obtient ou définit un indicateur qui signale si les informations d'identification sont mis en cache.


public bool CredentialCachingEnabled

Domain

Obtient ou définit le domaine ou l'ordinateur pour que les informations d'identification, il s'agit généralement du domaine de l'utilisateur actuel.

public string Domain

Lorsque cette propriété est définie sur une nouvelle valeur, la propriété Status est définie à NotStarted.

NavigateBackAfterAuthentication

Obtient ou définit un indicateur qui signale si l'utilisateur doit traverser, à la page précédente de la page de connexion.

public bool NavigateBackAfterAuthentication

Password

Obtient ou définit le mot de passe pour les informations d'identification.

public string Password

Lorsque cette propriété est définie sur une nouvelle valeur, la propriété Status est définie à NotStarted.

PromptOnFailure

Obtient ou définit un indicateur qui signale si l'utilisateur doit être invité à entrer un nom et un mot de passe en cas d'échec de l'authentification initiale.

public bool PromptOnFailure

Status (lecture seule)

Obtient l'état de la tentative d'authentification.

public AuthenticationStatus Status

Voir plus haut dans ce document pour plus d'informations sur la classe AuthenticationStatus.

UagServerUrl

Obtient ou définit l'URL du serveur UAG.

public Uri UagServerUrl

UserName

Obtient ou définit le nom d'utilisateur pour les informations d'identification.

public string UserName

Lorsque cette propriété est définie sur une nouvelle valeur, la propriété Status est définie à NotStarted.

Événements

AuthenticationCompleted

Déclenché lorsque la tentative d'authentification est terminée, indépendamment de si elle a réussi.

public event EventHandler<AuthenticationCompletedEventArgs> AuthenticationCompleted;

ClientAuthenticationMode enum

Spécifie un mode d'authentification pour un objet Authenticator. Il s'agit d'un enum existant auquel une nouvelle valeur, BrowserBasedAuthentication a été ajouté.

Type Description
FormsAuthentication Représente le mode d'authentification basée sur les formulaires
Anonymous Représente le mode d'accès anonyme
BrowserBasedAuthentication Représente le mode Microsoft Office Forms en fonction de l'authentification (MSOFBA)

Classe de ODataAuthenticator

Fournit des méthodes permettant d'authentifier un utilisateur sur un site Web SharePoint.

public class ODataAuthenticator : Authenticator

Constructeurs

Constructeurs sont identiques aux constructeurs de classe parent. Pour plus d'informations, consultez la rubrique authentificateur de classe, plus haut dans ce document.

Méthodes

Authenticate

Authentifie un utilisateur au site Web spécifié.

public new void Authenticate(Uri serverUrl)

Le new mot clé est utilisé, car la classe parente a une méthode interne du même nom.

Propriétés

CookieContainer (lecture seule)

Obtient un conteneur avec les cookies pour les demandes vers le site Web.

public new CookieContainer CookieContainer

Le new mot clé est utilisé, car la classe parente a une méthode interne du même nom.

ResolvedUrl (lecture seule)

Obtient l'URL qui est utilisé pour la communication vers le serveur qui exécute SharePoint lorsqu'un ODataAuthenticator est utilisé. Cela peut être l'URL publiée sur le serveur UAG ou, si la propriété AllowSmartRouting a la valeur true, il s'agit pas de l'URL d'intranet SharePoint si elle est tout d'abord atteint lorsque la méthode Authenticate est appelée.

public Uri ResolvedUrl

Classe de ServerSettings

Fournit une méthode pour l'obtention de l'URL de substitution de l'application web qui contient un site Web.

public static class ServerSettings

Méthodes

GetAlternateUrls

Obtient l'URL de substitution du site Web spécifié.

public static ClientObjectList<AlternateUrl> GetAlternateUrls(ClientRuntimeContext context)

Paramètres

context est l'objet représentant le contexte client actuel.

Voir plus haut dans ce document pour plus d'informations sur la classe AlternateUrl.

Modèle d'objet serveur SharePoint mobilité

Toutes les classes dans cette section se trouvent dans l'espace de noms Microsoft.SharePoint. À l'exception de l'emplacement spécifié, il s'agit également dans le modèle objet client. Pour les classes qui commencent par « SP », le nom du modèle objet client a le « SP » supprimée. Dans les autres cas, le nom du modèle objet client est spécifié. Les noms de membres sont les mêmes dans le modèle d'objet client à l'exception de l'emplacement spécifié dans le cas contraire.

Classe de GeolocationFieldControl

(Non disponible dans le modèle objet client).

Régit le rendu de champs de SPFieldGeolocation. Un objet de ce type est utilisé comme valeur de la propriété FieldRenderingControl d'un objet SPFieldGeolocation.

public class GeolocationFieldControl : BaseFieldControl

Dans le cadre de cette classe, Notez également qu'il existe des modèles de rendu deux, la valeur d'un mode d'affichage et un pour le mode de création et de modification. Ils sont définis dans le fichier %SHAREPOINTROOT%\TEMPLATE\ControlTemplates\DefaultTemplates.ascx.

Champs

Les éléments suivants sont utilisés pour afficher le champ dans les modes de création et de modification.

protected TextBox m_latitudeBox;
protected TextBox m_longitudeBox;
protected Label m_longitudeLabel;
protected Label m_latitudeLabel;

Méthodes

Aucune des propriétés publiques non dérivés ne sont générées par cette classe. Il existe des substitutions standard de certaines méthodes dérivées comme indiqué dans le tableau suivant.

Méthode Ce remplacement ???
CreateChildControls
 Crée les contrôles enfants, y compris un contrôle de feuille de route de JavaScript pour le mode d'affichage.
Focus
 Donne le focus au contrôle textbox enfant longitude.
OnPreRender
 Appelle la méthode de base.
Validate
 Valide les valeurs de latitude et longitude qui apparaissent dans l'interface utilisateur (IU). Cela ne valide pas les propriétés Longitude et Latitude de l'objet sous-jacent SPFieldGeolocatonValue qui sera différent si l'utilisateur a modifié une ou plusieurs des valeurs suivantes dans l'interface utilisateur et n'est pas encore enregistré les modifications.

Propriétés

Aucune des propriétés publiques non dérivés ne sont générées par cette classe. Il existe des substitutions standard de certaines propriétés dérivées comme indiqué dans le tableau suivant.

Propriété Cette substitution...
CssClass
 Se comporte comme la mise en œuvre parent.
DefaultTemplateName
 Renvoie « GeolocationField »
DisplayTemplateName
 Renvoie « GeolocationDisplayField »
Valeur
 Obtient ou définit la valeur qui s'affiche à l'aide d'un objet SPFieldGeolocationValue.

Classe de SPFieldGeolocation

Représente un champ (colonne) qui contient un emplacement de la planète défini par longitude, latitude et éventuellement altitude.


public class SPFieldGeolocation : SPField

Dans le cadre de cette classe, le type de champ Géolocalisation est défini dans % SHAREPOINTROOT%\TEMPLATE\XML\fldtypes.xml.

Constructeurs (surchargés)

Initialise une nouvelle instance de la classe SPFieldGeolocation.

public SPFieldGeolocation(SPFieldCollection fields, string fieldName)
public SPFieldGeolocation(SPFieldCollection fields, string fieldName, string displayName)

Paramètres

  • fields est la collection de types de champs à laquelle le nouvel objet de type de champ est ajouté.

  • fieldName est un nom interne du nouveau type de champ.

  • displayName est un nom convivial du nouveau type de champ.

Méthodes

GetFieldValueForClientRender

Obtient la valeur du champ afin qu'il peut être affiché sur le client.


public override object GetFieldValueForClientRender(SPItem item, SPControlMode mode)

Paramètres

  • item est l'élément de liste actuel.

  • mode est le mode de rendu actuel comme nouveau, modifier ou afficher.

GetJsonClientFormFieldSchema

Obtient le schéma de champ en tant que JavaScript Object Notation (JSON).

public override Dictionary<string, object> GetJsonClientFormFieldSchema(SPControlMode mode)

Paramètres

mode est le mode de rendu actuel comme nouveau, modifier ou afficher.

ValidateAndParseValue

Vérifie que l'élément de liste spécifié n'est pas null, puis vérifie que la chaîne est structurée en conformité avec Open géographiques Consortium normalisés et retourne comme un objet qui est castable au type SPFieldGeolocationValue.

public override object ValidateAndParseValue(SPListItem item, string value)

Paramètres

  • item est un élément de liste qui doit être mis à jour avec la valeur.

  • value est une représentation sous forme de chaîne d'une valeur de géolocalisation.

Les méthodes suivantes sont des remplacements standard des méthodes héritées qui se trouvaient dans SharePoint 2010. Les informations spécifiques à cette classe sont dans le tableau suivant.

Method Cette substitution...
GetFieldValue (String s)
 Renvoie la valeur spécifiée en tant qu'objet castable en SPFieldGeolocationValue.
GetFieldValueAsText (Object o)
 Ajuste GetValidatedString.
GetValidatedString (Object o)
 Vérifie que la valeur spécifiée est structurée en conformité avec Open géographiques Consortium normalisés et elle renvoie sous forme de chaîne.

Propriétés

JSLink

Obtient ou définit le nom du fichier JavaScript qui affiche les champs de type SPFieldGeolocation.

Notes

La propriété JSLink n’est pas prise en charge sur la liste d’enquête ou d’événements. Un calendrier SharePoint est une liste d'événements.

public override string JSLink

La valeur par défaut est « clienttemplates.js| Geolocationfieldtemplate.js|SP.Map.js ».

FieldRenderingMobileWebControl

Obtient l'objet SPMobileGeolocationField qui restitue le champ.

public override SPMobileBaseFieldControl FieldRenderingMobileControl

Cette propriété remplace la obsolète FieldRenderingMobileControl.

Les autres propriétés sont les substitutions standard de propriétés héritées qui se trouvaient dans SharePoint 2010. Les informations spécifiques à cette classe sont dans le tableau suivant.

Propriété La substitution...
FieldValueType
 Cette propriété renvoie typeof(SPFieldGeolocationValue).
FieldRenderingControl
 Renvoie un objet GeolocationFieldControl.
Filtrables
 Cette propriété renvoie false.
Triable
 Cette propriété renvoie false.
Obsolète.
FieldRenderingMobileControl
 Renvoie un objet SPMobileGeolocationField.

Classe de SPFieldGeolocationValue

Représente un emplacement de la planète défini par longitude, latitude et éventuellement altitude trop.

public class SPFieldGeolocationValue : SPFieldGeographyValue

Constructeurs (surchargés)

Initialise une nouvelle instance de la classe SPFieldGeolocationValue.

public SPFieldGeolocationValue()
public SPFieldGeolocationValue(string fieldValue)
public SPFieldGeolocationValue(double latitude, double longitude)
public SPFieldGeolocationValue(double latitude, double longitude, double altitude, double measure)

Paramètres

  • fieldValue est une chaîne dans un des formats texte Well-Known (WKT) suivants :

  • « Point( longitudelatitude) », où longitude et latitude sont des chaînes d’un ou plusieurs chiffres, incluant éventuellement un point (qui est interprété comme une virgule décimale) et éventuellement commençant par un trait d’union (qui est interprété comme un signe négatif).

  • « Point( longitudelatitudealtitudemesure) », où longitude, latitude, altitude et mesure sont des chaînes d’un ou plusieurs chiffres, incluant éventuellement un point (qui est interprété comme une virgule décimale) et éventuellement commençant par un trait d’union (qui est interprété comme un signe négatif).

  • latitude est la latitude et doit être compris entre -90.0 et 90.0.

  • longitude est la longitude et doit être compris entre -180.0 et 180.0.

  • altitude est l'altitude.

  • measure est une autre désignation du point. Voir la propriété Measure plus loin dans cette section pour plus d'informations.

Méthodes

ToString

Cette substitution retourne l'une des valeurs suivantes, selon que les propriétés Altitude ou Measure ont été assignées une valeur non nulle.

  • Si ni Altitude ni les mesures ont été affectés à une valeur non null :

    « Point( longitudelatitude) », où longitude et latitude sont des chaînes d’un ou plusieurs chiffres, incluant éventuellement un point (qui est interprété comme une virgule décimale) et éventuellement commençant par un trait d’union (qui est interprété comme un signe négatif).

  • Dans le cas contraire (au moins un des Altitude ou Measure affectés une valeur non nulle) :

    « Point(longitude latitude altitude mesure) », où longitude, latitude, altitude et mesure sont des chaînes d’un ou plusieurs chiffres, incluant éventuellement un point (qui est interprété comme une virgule décimale) et éventuellement commençant par un trait d’union (qui est interprété comme un signe négatif). If either Altitude or Measure has not been assigned a non-null value, it is reported as "0" in the value of the WellKnownText property. The converse does not hold: if either Altitude or Measure is reported as 0, that might be because it was never assigned a non-null value, but it might be because it was assigned 0.


public override string ToString()

ToWellKnownText

Ajuste ToString.

public string ToWellKnownText()

Propriétés

Altitude

Obtient ou définit l'altitude de l'emplacement. L'utilisation de cette propriété est facultative et le supposée unité de mesure (par exemple, mètres) et le point zéro (par exemple, au niveau de la mer ou centre de la terre) est définie par l'utilisateur.

public double Altitude

Latitude

Obtient ou définit la latitude de la localisation.

public double Latitude

La valeur doit être entre -90.0 et 90.0.

Longitude

Obtient ou définit la longitude de la localisation.

public double Longitude

La valeur doit être entre -180.0 et 180.0...

Measure

Obtient ou définit une désignation de substitution défini par l'utilisateur du point d'emplacement. Par exemple, si le point est le long d'un bus avec marqueurs de jalons, cette propriété pourrait être utilisée devant contenir le numéro du jalon qui est plus proche du point. Si le point se trouve dans une zone publique camping avec campings numérotées, cette propriété pourrait être utilisée pour contenir le nombre du site le plus proche de camping. La sémantique de la propriété est totalement déterminées par l'utilisateur et son utilisation est facultative.

public double Measure

SPFieldType enum

Une nouvelle valeur a été ajoutée à cet enum :

Geolocation

Classe de SPPhoneNotificationContent

Une classe de base pour les classes qui représentent le contenu d'une notification de téléphone. Classes dérivées doivent déclarer un ou plusieurs champs ou propriétés pour stocker le contenu et doivent implémenter la méthode PreparePayload pour transformer le contenu dans un tableau d'octets.

public abstract class SPPhoneNotificationContent

Méthodes

PreparePayload

Lorsqu'elle est implémentée dans une classe dérivée, transforme le contenu dans un tableau d'octets qui est transmis sur le réseau pour le service de notification. Il n'existe aucune implémentation par défaut pour une classe dérivée doit implémenter cette méthode.

protected internal abstract byte[] PreparePayload();

Propriétés

NotificationType (lecture seule)

Obtient le type de notification (par exemple, mosaïque ou toast) pour lequel le contenu est prévu.

public SPPhoneNotificationType NotificationType

Pour plus d'informations sur la SPPhoneNotificationType, voir plus loin dans ce document.

SubscriberType (lecture seule)

Obtient le type de périphérique de l'abonné, par exemple, un téléphone Windows.


public SPPhoneNotificationSubscriberType SubscriberType

Pour plus d'informations sur la SPPhoneNotificationSubscriberType, voir plus loin dans ce document.

Classe de SPPhoneNotificationResponse

Représente le résultat d'une tentative d'envoyer une notification.

public class SPPhoneNotificationResponse

Méthodes

Create

Crée un objet SPPhoneNotificationResponse.

public static SPPhoneNotificationResponse
Create(SPPhoneNotificationSubscriberType subscriberType,
SPPhoneNotificationType notificationType, HttpWebResponse response)

Paramètres

  • subscriberType est le périphérique, telles que Windows Phone 7.5.

  • notificationType est le type de notification, par exemple une vignette ou toast.

  • response est l'objet de réponse HTTP qui a été généré par le serveur.

Pour plus d'informations sur SPPhoneNotificationSubscriberType et SPPhoneNotificationType, voir plus loin dans ce document.

Propriétés

NotificationType (lecture seule)

Obtient le type de notification (par exemple, toast ou mosaïque).


public SPPhoneNotificationType NotificationType

Pour plus d'informations sur la SPPhoneNotificationType, voir plus loin dans ce document.

ServiceToken (lecture seule)

Obtient le jeton du service de notification qui a été utilisé dans la notification.

public string ServiceToken

StatusCode (lecture seule)

Obtient le code d'état HTTP. Une version de chaîne d'une valeur HttpStatusCode.

public string StatusCode

Type d’abonné

Obtient ou définit le type de périphérique pour lequel la notification a été envoyée.

public SPPhoneNotificationSubscriberType SubscriberType

Pour plus d'informations sur la SPPhoneNotificationSubscriberType, voir plus loin dans ce document.

TimeStamp (lecture seule)

L'heure UTC de la notification.

public DateTime Timestamp

Classe de SPPhoneNotificationSubscriber

Une classe de base pour les classes qui représentent un abonné aux notifications émises par l'application SharePoint côté serveur.

public abstract class SPPhoneNotificationSubscriber

Méthodes

Notification

Envoie le contenu de notification spécifié à l'abonné au moyen de vérification des erreurs.

public SPPhoneNotificationResponse Notify(SPPhoneNotificationContent notificationContent)

Paramètres

notificationContent est plus d'informations sur l'événement qui a déclenché la notification.

Cette méthode ne peut pas être remplacée. Elle encapsule la méthode abstraite NotifyInternal et s'assure que certaines vérification des erreurs s'effectue lorsque NotifyInternal est appelée.

Pour plus d'informations sur les classes SPPhoneNotificationContent et SPPhoneNotificationResponse, reportez-vous à la section plus haut dans ce document.

NotifyInternal

En cas de substitution dans une classe dérivée, envoie le contenu de notification spécifié à l'abonné.

protected abstract SPPhoneNotificationResponse NotifyInternal(SPPhoneNotificationContent notificationContent);

Paramètres

notificationContent est plus d'informations sur l'événement qui a déclenché la notification.

Pour plus d'informations sur les classes SPPhoneNotificationContent et SPPhoneNotificationResponse, reportez-vous à la section plus haut dans ce document.

ToString

Renvoie les propriétés sélectionnées de l'objet sous forme de chaîne.

public override string ToString()

L'implémentation par défaut inclut les propriétés ParentWeb, ApplicationTaget DeviceAppInstanceId.

Mettre à jour

Enregistre un objet (éventuellement modifié) SPPhoneNotificationSubscriber au magasin d'abonné du site Web.

public void Update()

ValidateSubscriberProperties

Lorsqu'elle est implémentée dans une classe dérivée, valide les propriétés de l'objet sélectionnées.

protected abstract void ValidateSubscriberProperties();

Propriétés

CustomArgs

Obtient ou définit une chaîne d'arguments personnalisés qui représente l'état de l'abonnement de notifications. Cette chaîne peut être utilisée par la logique de l'application faire la distinction entre ses abonnés de notification pour les différents types de notifications.

public string CustomArgs

DeviceAppInstanceId (lecture seule)

Obtient un ID de l'instance spécifique de l'application sur le téléphone ou un autre périphérique mobile.

public Guid DeviceAppInstanceId

LastModifiedTimeStamp (lecture seule)

Obtient la date et l'heure de la dernière modification de l'abonné.

public DateTime LastModifiedTimeStamp

RegistrationTimeStamp (lecture seule)

Obtient la date et heure lorsque l'abonné inscrits pour les notifications.

public DateTime RegistrationTimeStamp

ServiceToken

Obtient ou définit les informations de canal de remise qui sont requis par un service de notification, tels que les URI du canal.

public string ServiceToken

SubscriberType (lecture seule)

Obtient le type de périphérique, telles que Windows Phone 7.

public SPPhoneNotificationSubscriberType SubscriberType

Pour plus d'informations sur la classe SPPhoneNotificationSubscriberType, voir plus loin dans ce document.

User (lecture seule)

Obtient l'utilisateur inscrit pour les notifications.

public SPUser User

Classe de SPPhoneNotificationSubscriberCollection

Collection d'abonnés de notification. La collection d'objets prend les indexeurs Int32.

public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection

Propriétés

Count

Obtient le nombre d'éléments dans la collection.

public override int Count

SPPhoneNotificationSubscriberType enum

Spécifie un type de périphérique qui peut recevoir des notifications.

Notification Appareil
WP7
Windows Phone 7.5
Custom
N'importe quel appareil autre que Windows Phone 7.5

SPPhoneNotificationType enum

Spécifie le type de notification.

-None -Tile -Toast -Raw

Classe SPWeb

Les membres suivants ont été ajoutés à cette classe.

Méthodes

DoesPhoneNotificationSubscriberExist

Obtient une valeur qui indique si l'utilisateur actuel est un abonné pour l'instance spécifiée de l'application spécifiée.

public bool DoesPhoneNotificationSubscriberExist(Guid deviceAppInstanceId)

GetPhoneNotificationSubscriber

Obtient un abonné aux notifications avec l'application spécifiée et ID de téléphone à partir de la liste des abonnements notification du site Web.

public SPPhoneNotificationSubscriber GetPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Paramètres

deviceAppInstanceId est un identificateur pour l'instance de l'application sur un téléphone spécifique ou un périphérique.

Pour plus d'informations sur la classe SPPhoneNotificationSubscriber, voir plus haut dans ce document.

GetPhoneNotificationSubscribers (surchargé)

Obtient une collection d'abonnés de notification à partir de la liste d'abonnements de notification du site Web, éventuellement le filtrage sur le ID des applications téléphoniques et éventuellement aussi sur une des opérations suivantes : l'utilisateur ou des arguments personnalisés.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string customArgs)

Notes

[!REMARQUE] Nom du modèle objet client est GetPhoneNotificationSubscribersByArgs.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string user)

Notes

[!REMARQUE] Nom du modèle objet client est GetPhoneNotificationSubscribersByUser.

Paramètres

  • customArgs sont des informations personnalisées supplémentaires susceptibles d'utiliser certaines applications prenant en charge notification.

  • user est l'utilisateur inscrit pour les notifications.

Pour plus d'informations sur la classe SPPhoneNotificationSubscriberCollection, voir plus haut dans ce document.

RegisterPhoneNotificationSubscriber

Enregistre une application de téléphone sur un téléphone pour recevoir des notifications.


public SPPhoneNotificationSubscriber RegisterPhoneNotificationSubscriber(SPPhoneNotificationSubscriberType subscriberType, Guid deviceAppInstanceId, string serviceToken)

Paramètres

  • subscriberType est le type de périphérique, telles que Windows Phone 7.

  • deviceAppInstanceId est un identificateur pour l'instance de l'application sur un téléphone spécifique ou un périphérique.

  • serviceToken est le jeton qui est utilisé par le service de notification qui envoie des notifications à l'abonné.

Pour plus d'informations sur SPPhoneNotificationSubscriberType, reportez-vous à la section plus haut dans ce document.

UnregisterPhoneNotificationSubscriber

Annule l'inscription d'une application téléphonique sur un téléphone de recevoir des notifications.

public void UnregisterPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Paramètres

deviceAppInstanceId est un identificateur pour l'instance de l'application sur un téléphone spécifique ou un périphérique.

Propriétés

PhoneNotificationSubscribers (lecture seule)

Obtient une collection du téléphone de tous les abonnés de notification dans le magasin d'abonné du site Web.

public SPPhoneNotificationSubscriberCollection PhoneNotificationSubscribers

Pour plus d'informations sur la classe SPPhoneNotificationSubscriberCollection, reportez-vous à la section plus haut dans ce document.

Classe de WP7NotificationTileContent

Représente le contenu d'une notification de mosaïque.

public sealed class WP7NotificationTileContent : SPPhoneNotificationContent

Constructeurs

Initialise une nouvelle instance de la classe WP7NotificationTileContent.

public WP7NotificationTileContent()

Méthodes

PreparePayload

Transforme le contenu dans un tableau de Byte qui est transmis sur le réseau pour le service de notification.

protected internal override byte[] PreparePayload();

Propriétés

Count

Obtient ou définit le nombre de la notification. Doit être compris entre -1 et 99 inclus.

public int Count

La propriété-1 ne modifie pas le décompte sur la mosaïque.

Title

Obtient ou définit le titre de la notification de mosaïque.

public string Title

BackgroundImagePath

Obtient ou définit le chemin d'accès à l'image d'arrière-plan de la mosaïque.

public string BackgroundImagePath

BackBackgroundImagePath

Obtient ou définit l'image d'arrière-plan du côté arrière une mosaïque retournement.

public string BackBackgroundImagePath

BackContent

Obtient ou définit le contenu du côté arrière une mosaïque retournement.

public string BackContent

BackTitle

Obtient ou définit le titre qui s'affiche sur le côté arrière d'une mosaïque de retournement.

public string BackTitle

TileId

Obtient ou définit l'ID de la mosaïque.

public string TileId

Classe de WP7NotificationToastContent

Représente le contenu d'une notification toast.

public sealed class WP7NotificationToastContent : SPPhoneNotificationContent

Constructeurs

Initialise une nouvelle instance de la classe WP7NotificationToastContent.

public WP7NotificationToastContent()

Méthodes

PreparePayload

Transforme le contenu dans un tableau de Byte qui est transmis sur le réseau pour le service de notification.

protected internal override byte[] PreparePayload();

Propriétés

Message

Obtient ou définit le message de la notification toast.

public string Message

Title

Obtient ou définit le titre de la notification toast.

public string Title

Param

Obtient ou définit les données des paramètres personnalisés qui sont transmises à l'application destinataire, si l'utilisateur répond à la notification toast.

public string Param

Cette propriété peut être utilisée pour transmettre des informations à l'application destinataire, par exemple une URL ou un ensemble de paires nom-valeur.

Classe de WP7NotificationRawContent

Représente le contenu d'une notification brute.

public sealed class WP7NotificationRawContent : SPPhoneNotificationContent

Constructeurs

Initialise une nouvelle instance de la classe WP7NotificationRawContent.

public WP7NotificationRawContent()

Méthodes

PreparePayload

Transforme le contenu dans un tableau d'octets qui est transmis sur le réseau pour le service de notification.

protected internal override byte[] PreparePayload();

Propriétés

Message

Obtient ou définit le message de la notification brute.

public string Message

Classe de WP7PhoneNotificationResponse

Représente le résultat d'une tentative d'envoyer une notification à un abonné de Windows Phone 7.

public WP7PhoneNotificationResponse(SPPhoneNotificationType notificationType, HttpWebResponse response)

Paramètres

  • notificationType est le type de notification, par exemple une vignette ou toast.

  • response est l'objet de réponse HTTP qui a été généré par le serveur.

Pour plus d'informations sur SPPhoneNotificationType, reportez-vous à la section plus haut dans ce document.

Propriétés

NotificationStatus (lecture seule)

Obtient l'état de notification, par exemple, réussite ou échec.

public string NotificationStatus

DeviceConnectionStatus (lecture seule)

Obtient l'état de l'appareil au moment de la notification.

public string DeviceConnectionStatus

SubscriptionStatus (lecture seule)

L'état de l'abonnement de l'appareil au moment de la notification.

public string SubscriptionStatus

MessageId (lecture seule)

Obtient l'ID du message qui a été envoyé dans la notification.

public string MessageId

Voir aussi