Übersicht über das mobile SharePoint-Objektmodell

Informationen Sie zu neuen öffentlichen Klassen im Serverobjektmodell SharePoint und Silverlight-Clientobjektmodell, die zum Entwickeln von integrierter Lösungen für SharePoint und Windows Phone 7.5 verwendet werden.

Clientobjektmodell für mobile Silverlight

Alle Klassen in diesem Abschnitt werden im Microsoft.SharePoint.Client -Namespace. Zusätzlich zu den APIs in diesem Abschnitt können die meisten Klassen und Member im Abschnitt Serverobjektmodell für die SharePoint-Mobilität auch in das Clientobjektmodell aufgerufen werden. Für Klassen, die mit "SP" beginnen, wird der Client-Objekt Modellname der "SP" entfernt. In anderen Fällen wird der Client Modell Objektname angegeben. Elementnamen sind die gleichen in des Clientobjektmodells, es sei denn, in denen anders angegeben.

AlternateUrl-Klasse

Stellt eine alternative URL für eine Webanwendung und die Zone, für die sie gilt.

public class AlternateUrl

Eigenschaften

Uri (schreibgeschützt)

Ruft den URI der alternativen URL ab.

public String Uri

UrlZone (schreibgeschützt)

Ruft die Zone der alternativen URL an.

public UrlZone UrlZone

Die UrlZone-Klasse ist die Client-Objektmodellversion der SPUrlZone-Klasse im Serverobjektmodell. Weitere Informationen hierzu finden Sie im SharePoint 2010 Software Development Kit (SDK).

AuthenticationCompletedEventArgs-Klasse

Stellt Daten über ein AuthenticationCompleted -Ereignis bereit.

public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs

Konstruktoren

Initialisiert eine neue Instanz der AuthenticationCompletedEventArgs-Klasse.

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

Parameter

• error ist das Exception-Objekt, wenn es eine Ausnahme ausgelöst wird, in der Authentifizierungsversuch wurde.
• canceled ist True, wenn der Authentifizierungsversuch abgebrochen wurde, bevor es erfolgreich oder fehlgeschlagen konnte.
• userState ist die HttpStatusCode vom Server zurückgegeben.

Eigenschaften

HttpStatusCode (schreibgeschützt)

Ruft den Status, die vom Server nach einen Authentifizierungsversuch zurückgegeben.

public HttpStatusCode HttpStatusCode

AuthenticationStatus-Enumeration

Gibt den aktuellen Status des einen Authentifizierungsversuch.

• NotStarted
• InProgress
• CompletedSuccess
• CompletedException

Authentifizierungsserver-Klasse

Stellt Methoden zum Authentifizieren eines Benutzers auf einer SharePoint-Website bereit.

public class Authenticator : ICredentials

Konstruktoren

Initialisiert eine neue Instanz der Klasse an.

public Authenticator()

public Authenticator(Uri uagServerUrl)

ParameteruagServerUrl ist die absolute URL eines UAG-Servers (United Access Gateway).

public Authenticator(string userName, string password)

ParametersuserName ist der Name für die Anmeldeinformationen. password ist das Kennwort für die Anmeldeinformationen.

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

ParametersuserName ist der Name für die Anmeldeinformationen. password ist das Kennwort für die Anmeldeinformationen. domain ist der Name der Domäne oder des Computers, auf dem die Anmeldeinformationen überprüft werden, in der Regel die Domäne des aktuellen Benutzers.

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

ParametersuserName ist der Name für die Anmeldeinformationen. password ist das Kennwort für die Anmeldeinformationen. uagServerUrl ist die absolute URL eines Servers United Access Gateway (UAG).

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

ParametersuserName ist der Name für die Anmeldeinformationen. password ist das Kennwort für die Anmeldeinformationen. domain ist der Name der Domäne oder des Computers, auf dem die Anmeldeinformationen überprüft werden, in der Regel die Domäne des aktuellen Benutzers. uagServerUrl ist die absolute URL eines Servers United Access Gateway (UAG).

Methoden

ClearAllApplicationSettings Löscht alle Cookies, Anmeldeinformationen und UAG-Einstellungen aus dem Cache.

public static void ClearAllApplicationSettings()

ClearAllCookies Löscht alle gespeicherten Cookies und legt die Status-Eigenschaft aller Authenticator-Objekte auf NotStarted fest.

public static void ClearAllCookies()

ClearAllCredentials Löscht alle Anmeldeinformationen aus dem Cache und legt die Status-Eigenschaft aller Authenticator-Objekte auf NotStarted fest.

public static void ClearAllCredentials()

Getcredential Ruft ein Anmeldeinformationsobjekt für den angegebenen URI und Authentifizierungstyp ab.

public NetworkCredential GetCredential(Uri uri, string authType)

Parameter

• uri ist der URI, einschließlich der Port, für die der Client die Authentifizierung bereitstellt.
• authType ist die Art der Authentifizierung angefordert.

Diese Methode ist nur für die anonyme Authentifizierung verwendet. Wenn authType nicht "Basic" ist, wird ein leeres Objekt zurückgegeben. Weitere Informationen über die NetworkCredential -Klasse finden Sie unter NetworkCredential-Klasse. IsRequestUnauthorized Gibt true zurück, wenn die Autorisierungsanforderung aufgrund eines ungültigen Cookies oder ungültiger Anmeldeinformationen fehlgeschlagen ist.

public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEventArgs)

Eigenschaften

AllowSmartRouting Ruft einen Indikator ab, der angibt, ob intelligentes Routing aktiviert ist, oder legt diese fest.

public bool AllowSmartRouting

Wenn intelligentes Routing aktiviert ist, versucht das Authenticator-Objekt , eine Verbindung mit dem Server herzustellen, auf dem SharePoint und der UAG-Server ausgeführt wird, und verwendet je nachdem, was zuerst antwortet, als Kommunikationskanal. Wenn kein UAG-Server vorhanden ist, wird diese Eigenschaft ignoriert. The default is true. Wenn false, dem UAG-Server immer verwendet wird.

AuthenticatorMode

Ruft ab oder legt den Authentifizierungsmodus fest.

public ClientAuthenticationMode AuthenticationMode

Weitere Informationen zu den ClientAuthenticationMode -Enumeration finden Sie weiter unten in diesem Dokument.

CookieCachingEnabled Ruft einen Indikator ab, der angibt, ob Cookies zwischengespeichert werden, oder legt diese fest.

public bool CookieCachingEnabled

Wenn Sie das Zwischenspeichern von Cookies aktivieren, sollten Sie Sie, dass die Cookies zu einem bestimmten Zeitpunkt ablaufen. Wenn sie beim Aufruf von ExecuteQueryAsync abgelaufen sind, tritt ein Fehler auf, und der Rückruf für Fehler wird ausgeführt. Entsprechend, wenn Sie diese Eigenschaft auf True festlegen, müssen Sie Code für den Rückruf für Fehler hinzufügen, die den Cache gelöscht, in diesem Fall. Hier ist ein Beispiel, bei dem execQueryArgs vom Typ ClientRequestFailedEventArgs ist, der im Fehlerrückruf von ExecuteQueryAsync übergeben wird.

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

CredentialCachingEnabled Ruft einen Indikator ab, der angibt, ob Anmeldeinformationen zwischengespeichert werden, oder legt diese fest.

public bool CredentialCachingEnabled

Domäne Ruft die Domäne oder den Computer für die Anmeldeinformationen ab oder legt diese fest. In der Regel ist dies die Domäne des aktuellen Benutzers.

public string Domain

Wenn diese Eigenschaft auf einen neuen Wert festgelegt ist, wird die Status -Eigenschaft auf nicht gestartet festgelegt.

NavigateBackAfterAuthentication Ruft einen Indikator ab, der angibt, ob der Benutzer von der Anmeldeseite zurück zur vorherigen Seite navigiert werden soll, oder legt diesen fest.

public bool NavigateBackAfterAuthentication

Passwort Ruft das Kennwort für die Anmeldeinformationen ab oder legt es fest.

public string Password

Wenn diese Eigenschaft auf einen neuen Wert festgelegt ist, wird die Status -Eigenschaft auf NotStartedfestgelegt.

PromptOnFailure

Ruft ab oder legt diesen fest einen Indikator gibt an, ob der Benutzer aufgefordert werden soll, einen Namen und ein Kennwort eingeben, wenn die erste Authentifizierung ein Fehler auftritt.

public bool PromptOnFailure

Status (schreibgeschützt) Ruft die status des Authentifizierungsversuchs ab.

public AuthenticationStatus Status

Finden Sie weiter oben in diesem Dokument, um Informationen über die AuthenticationStatus -Klasse.

UagServerUrl

Dient zum Abrufen oder Festlegen der URL des UAG-Server.

public Uri UagServerUrl

UserName

Ruft ab oder legt den Benutzernamen für die Anmeldeinformationen.

public string UserName

Wenn diese Eigenschaft auf einen neuen Wert festgelegt ist, wird die Status -Eigenschaft auf NotStartedfestgelegt.

Veranstaltungen

AuthenticationCompleted

Wird ausgelöst, wenn der Authentifizierungsversuch unabhängig davon, ob es erfolgreich abgeschlossen wurde.

public event EventHandler<AuthenticationCompletedEventArgs> AuthenticationCompleted;

ClientAuthenticationMode-Enumeration

Gibt einen Authentifizierungsmodus für ein Authenticator -Objekt an. Hierbei handelt es sich um eine vorhandene Enumeration an die, einen neuen Wert BrowserBasedAuthentication hinzugefügt wurde.

ODataAuthenticator-Klasse

Stellt Methoden zum Authentifizieren eines Benutzers auf einer SharePoint-Website bereit.

public class ODataAuthenticator : Authenticator

Konstruktoren

Die Konstruktoren sind identisch mit der übergeordneten Klassenkonstruktoren. Weitere Informationen finden Sie weiter oben in diesem Dokument Authentifizierungsserver-Klasse.

Methoden

Authentifizieren Authentifiziert einen Benutzer bei der angegebenen Website.

public new void Authenticate(Uri serverUrl)

Die new Schlüsselwort (keyword) wird verwendet, da die übergeordnete Klasse über eine interne Methode mit demselben Namen verfügt.

Eigenschaften

CookieContainer (schreibgeschützt) Ruft einen Container mit den Cookies für Anforderungen an die Website ab.

public new CookieContainer CookieContainer

Die new Schlüsselwort (keyword) wird verwendet, da die übergeordnete Klasse über eine interne Methode mit demselben Namen verfügt.

ResolvedUrl (schreibgeschützt)

Ruft die URL ab, die für die Kommunikation mit dem Server verwendet wird, auf dem SharePoint ausgeführt wird, wenn ein ODataAuthenticator verwendet wird. Dies kann die url sein, die auf dem UAG-Server veröffentlicht wurde, oder, wenn die AllowSmartRouting-Eigenschaft true ist, die SharePoint-Intranet-URL, wenn sie beim Aufruf der Authenticate-Methode zuerst erreicht wird.

public Uri ResolvedUrl

ServerSettings-Klasse

Stellt eine Methode zum Abrufen von alternativen URLs der Webanwendung, die eine Website enthält.

public static class ServerSettings

Methoden

GetAlternateUrls Ruft die alternativen URLs der angegebenen Website ab.

public static ClientObjectList<AlternateUrl> GetAlternateUrls(ClientRuntimeContext context)

Parameterkontext ist das Objekt, das den aktuellen Clientkontext darstellt. Finden Sie weiter oben in diesem Dokument, um Informationen über die AlternateUrl -Klasse.

Objektmodell für Mobilität mit SharePoint Server

Alle Klassen in diesem Abschnitt werden im Microsoft.SharePoint -Namespace. Es sei denn, in denen angegeben werden sind diese ebenfalls in das Clientobjektmodell verfügbar. Für Klassen, die mit "SP" beginnen, wird der Client-Objekt Modellname der "SP" entfernt. In anderen Fällen wird der Client Modell Objektname angegeben. Elementnamen sind die gleichen in des Clientobjektmodells, es sei denn, in denen anders angegeben.

GeolocationFieldControl-Klasse

(Nicht verfügbar im Client Object Model).

Steuert das Rendern von Feldern SPFieldGeolocation. Ein Objekt dieses Typs wird als der Wert der FieldRenderingControl -Eigenschaft eines SPFieldGeolocation -Objekts verwendet.

public class GeolocationFieldControl : BaseFieldControl

Beachten Sie bei dieser Klasse auch, dass es zwei Renderingvorlagen gibt: eine für den Anzeigemodus und eine für den Modus Neu und Bearbeiten. Sie sind in der Datei %SHAREPOINTROOT%\TEMPLATE\ControlTemplates\DefaultTemplates.ascx definiert.

Felder

Die folgenden dienen zum Rendern des Felds in der neuen und bearbeiteten Modi verwendet.

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

Methoden

Mit dieser Klasse sind keine nicht abgeleitete öffentlichen Eigenschaften eingeführt. Standard Außerkraftsetzungen von einigen abgeleiteten Methoden sind vorhanden, wie in der folgenden Tabelle angegeben.

Eigenschaften

Mit dieser Klasse sind keine nicht abgeleitete öffentlichen Eigenschaften eingeführt. Standard Außerkraftsetzungen von einige abgeleiteten Eigenschaften sind vorhanden, wie in der folgenden Tabelle angegeben.

SPFieldGeolocation-Klasse

Stellt ein Feld (Spalte), das ein Verzeichnis auf der ganzen Welt von Längengrad, Breiten- und möglicherweise Höhe definierten enthält.

public class SPFieldGeolocation : SPField

Bei dieser Klasse wird der Geolocation-Feldtyp in % SHAREPOINTROOT%\TEMPLATE\XML\fldtypes.xml definiert.

Konstruktoren (überladen)

Initialisiert eine neue Instanz der SPFieldGeolocation -Klasse.

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

Parameter

• fields ist die Auflistung der Feldtypen dar, die das neue Feld Typ-Objekt hinzugefügt wird.
• fieldName ist ein interner Name des neuen Feldtyps.
• displayName ist ein Anzeigename des neuen Feldtyps.

Methoden

GetFieldValueForClientRender Ruft den Wert des Felds ab, damit es auf dem Client gerendert werden kann.

public override object GetFieldValueForClientRender(SPItem item, SPControlMode mode)

Parameter

• item ist das aktuelle Listenelement.
• mode ist die aktuelle Rendermodus wie neu, bearbeiten oder anzeigen.

GetJsonClientFormFieldSchema Ruft das Feldschema als JavaScript Object Notation (JSON) ab.

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

Der Parametermodus ist der aktuelle Renderingmodus, z. B. Neu, Bearbeiten oder Anzeigen.

ValidateAndParseValue Überprüft, ob das angegebene Listenelement nicht NULL ist, und überprüft dann, ob die Zeichenfolge in Übereinstimmung mit OGC-Standards (Open Geospatial Consortium) strukturiert ist, und gibt es als Objekt zurück, das in den SPFieldGeolocationValue-Typ umgewandelt werden kann.

public override object ValidateAndParseValue(SPListItem item, string value)

Parameter

• item ist ein Listenelement, das mit dem Wert aktualisiert werden soll.
• value ist eine Zeichenfolgendarstellung eines Geolocation-Werts.

Die folgenden Methoden sind standard Außerkraftsetzungen von geerbten Methoden, die in SharePoint 2010 waren. Die spezifische Informationen für diese Klasse ist in der folgenden Tabelle.

Eigenschaften

Jslink Ruft den Namen der JavaScript-Datei ab, die die Felder des SPFieldGeolocation-Typs rendert, oder legt diesen fest.

public override string JSLink

Der Standardwert ist "clienttemplates.js| Geolocationfieldtemplate.js|SP.Map.js".

FieldRenderingMobileWebControl Ruft das SPMobileGeolocationField-Objekt ab, das das Feld rendert.

public override SPMobileBaseFieldControl FieldRenderingMobileControl

Diese Eigenschaft ersetzt die veraltete FieldRenderingMobileControl. Die anderen Eigenschaften sind standard Außerkraftsetzungen von geerbten Eigenschaften, die in SharePoint 2010 waren. Die spezifische Informationen für diese Klasse ist in der folgenden Tabelle.

SPFieldGeolocationValue-Klasse

Stellt ein Verzeichnis auf der ganzen Welt zu durch Längengrad, Breiten- und möglicherweise Höhe definiert.

public class SPFieldGeolocationValue : SPFieldGeographyValue

Konstruktoren (überladen)

Initialisiert eine neue Instanz der SPFieldGeolocationValue -Klasse.

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

Parameter

• fieldValue ist eine Zeichenfolge in einem der folgenden Formate Well-Known Text (WKT):
  • "Point(longitude_ latitude)", wobei Längen- und Breitengrad Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird).
  • "Point(longitude_ latitudealtitudemeasure)", wobei Längengrad, Breitengrad, Höhe und Measure Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird).
• latitude ist die Breite und muss zwischen 90,0 und 90,0.
• longitude ist die Längengrad und muss zwischen 180,0 und 180,0.
• altitude ist die Höhe an.
• measure ist eine alternative Bezeichnung des Punkts. Siehe Measure -Eigenschaft weiter unten in diesem Abschnitt Weitere Informationen.

Methoden

ToString Diese Außerkraftsetzung gibt eine der folgenden Rückgaben zurück, je nachdem, ob den Eigenschaften Altitude oder Measure ein Wert ungleich NULL zugewiesen wurde.

• Wenn weder Höhe noch Measure einen Null-Wert zugewiesen wurde:

  "Point(longitude_ latitude)", wobei Längen- und Breitengrad Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird).

• Andernfalls (mindestens einer der Altitude oder Measure zugewiesen wurden einen Null-Wert):

  "Point(longitude latitude altitude measure)", wobei Längengrad, Breitengrad, Höhe und Measure Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird). Wenn entweder Altitude oder Measure keinen Wert ungleich NULL zugewiesen wurde, wird er im Wert der WellKnownText-Eigenschaft als "0" gemeldet. Das Gegenteil gilt nicht: Wenn entweder Höhe oder Measure als 0 gemeldet wird, liegt dies möglicherweise daran, dass ihm nie ein Nicht-NULL-Wert zugewiesen wurde, aber es kann daran sein, dass ihm 0 zugewiesen wurde.

public override string ToString()

ToWellKnownText UmschließtToString.

public string ToWellKnownText()

Eigenschaften

Altitude

Dient zum Abrufen oder festlegen die Höhe des Speicherorts. Die Verwendung dieser Eigenschaft ist optional, und die angenommene Maßeinheit (z. B. Meter) und Nullpunkt (z. B. Meeresspiegel oder Erdmittelpunkt) sind benutzerdefinierte.

public double Altitude

Latitude

Dient zum Abrufen oder Festlegen der Breite des Speicherorts.

public double Latitude

Der Wert muss zwischen 90,0 und 90,0.

Länge Ruft den Längengrad des Standorts ab oder legt diese fest.

public double Longitude

Der Wert muss zwischen -180,0 und 180,0 sein.

Measure

Ruft ab oder legt eine alternative Bezeichnung des Punkts Speicherort. Wenn sich der Punkt beispielsweise entlang einer Autobahn mit Meilensteinmarkierungen befindet, kann diese Eigenschaft verwendet werden, um die Nummer des Meilensteins zu speichern, der dem Punkt am nächsten ist. Wenn der Punkt in einem öffentlichen camping Bereich mit nummerierten Zeltplätze ist, konnte diese Eigenschaft verwendet werden, die die Anzahl der der nächste Campsite enthalten soll. Die Semantik der-Eigenschaft ist vollständig benutzergesteuerten und deren Verwendung ist optional.

public double Measure

SPFieldType-Enumeration

Diese Enumeration verfügt über ein neuer Wert hinzugefügt wurde:

Geolocation

SPPhoneNotificationContent-Klasse

Eine Basisklasse für Klassen, die den Inhalt einer Benachrichtigung Telefon darstellen. Abgeleitete Klassen müssen deklarieren Sie eine oder mehrere Felder oder Eigenschaften, die den Inhalt enthalten und müssen die PreparePayload -Methode, um den Inhalt in ein Bytearray transformieren implementieren.

public abstract class SPPhoneNotificationContent

Methoden

PreparePayload

Wenn in einer abgeleiteten Klasse implementiert wird, überträgt den Inhalt in ein Bytearray, die über das Netzwerk mit dem Benachrichtigungsdienst gesendet wird. Es gibt keine Standardimplementierung, sodass eine abgeleitete Klasse diese Methode implementieren muss.

protected internal abstract byte[] PreparePayload();

Eigenschaften

NotificationType (schreibgeschützt)

Ruft den Typ der Benachrichtigung (beispielsweise Kacheln oder Toast) für die Inhalte konzipiert ist.

public SPPhoneNotificationType NotificationType

Informationen zu den SPPhoneNotificationTypefinden Sie weiter unten in diesem Dokument.

SubscriberType (schreibgeschützt)

Ruft den Typ des Abonnenten beispielsweise eine Windows Phone-Gerät ab.

public SPPhoneNotificationSubscriberType SubscriberType

Informationen zu den SPPhoneNotificationSubscriberTypefinden Sie weiter unten in diesem Dokument.

SPPhoneNotificationResponse-Klasse

Stellt das Ergebnis der Versuch, eine Benachrichtigung zu senden.

public class SPPhoneNotificationResponse

Methoden

Erstellen Erstellt ein SPPhoneNotificationResponse-Objekt .

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

Parameter

• subscriberType ist das Gerät, wie beispielsweise Windows Phone 7.5.
• notificationType ist der Typ der Benachrichtigung, wie Toast oder Kachel.
• response ist die HTTP-Antwortobjekt, das vom Server generiert wurde.

Weitere Informationen zu SPPhoneNotificationSubscriberType und SPPhoneNotificationTypefinden Sie weiter unten in diesem Dokument.

Eigenschaften

NotificationType (schreibgeschützt)

Ruft den Typ der Benachrichtigung (beispielsweise Toast oder nebeneinander).

public SPPhoneNotificationType NotificationType

Informationen zu den SPPhoneNotificationType finden Sie weiter unten in diesem Dokument.

ServiceToken (schreibgeschützt) Ruft das Token des Benachrichtigungsdiensts ab, der in der Benachrichtigung verwendet wurde.

public string ServiceToken

StatusCode (schreibgeschützt) Ruft den HTTP-status Code ab. Eine Zeichenfolgenversion einesHttpStatusCode-Werts .

public string StatusCode

SubscriberType Ruft den Typ des Geräts ab, an das die Benachrichtigung gesendet wurde, oder legt diesen fest.

public SPPhoneNotificationSubscriberType SubscriberType

Informationen zu den SPPhoneNotificationSubscriberTypefinden Sie weiter unten in diesem Dokument. TimeStamp (schreibgeschützt) Die UTC-Zeit der Benachrichtigung.

public DateTime Timestamp

SPPhoneNotificationSubscriber-Klasse

Eine Basisklasse für Klassen, die ein-Abonnent auf einer SharePoint-Anwendung serverseitige einstufen Benachrichtigungen darstellen.

public abstract class SPPhoneNotificationSubscriber

Methoden

Benachrichtigen Sendet den angegebenen Benachrichtigungsinhalt mit Fehlerüberprüfung an den Abonnenten.

public SPPhoneNotificationResponse Notify(SPPhoneNotificationContent notificationContent)

ParameternotificationContent sind Informationen über das Ereignis, das die Benachrichtigung ausgelöst hat. Diese Methode kann nicht überschrieben werden. Umschließt die abstrakte NotifyInternal -Methode, und stellt sicher, dass bestimmte fehlerüberprüfung durchgeführt wird, wenn NotifyInternal aufgerufen wird. Weitere Informationen zu den Klassen SPPhoneNotificationContent und SPPhoneNotificationResponse finden Sie weiter oben in diesem Dokument.

NotifyInternal Sendet beim Überschreiben in einer abgeleiteten Klasse den angegebenen Benachrichtigungsinhalt an den Abonnenten.

protected abstract SPPhoneNotificationResponse NotifyInternal(SPPhoneNotificationContent notificationContent);

ParameternotificationContent sind Informationen über das Ereignis, das die Benachrichtigung ausgelöst hat.

Weitere Informationen zu den Klassen SPPhoneNotificationContent und SPPhoneNotificationResponse finden Sie weiter oben in diesem Dokument.

ToString Gibt ausgewählte Eigenschaften des Objekts als Zeichenfolge zurück.

public override string ToString()

Die standardmäßige Implementierung enthält die Eigenschaften ParentWeb, ApplicationTagund DeviceAppInstanceId.

Aktualisieren

Speichert ein (möglicherweise geänderten) SPPhoneNotificationSubscriber -Objekt an der Website Abonnenten Store.

public void Update()

ValidateSubscriberProperties Überprüft bei Implementierung in einer abgeleiteten Klasse ausgewählte Eigenschaften des Objekts.

protected abstract void ValidateSubscriberProperties();

Eigenschaften

CustomArgs

Ruft eine benutzerdefinierte Argumentzeichenfolge ab, die den Status des Benachrichtigungsabonnements darstellt, oder legt diese fest. Diese Zeichenfolge konnte von der Anwendungslogik zur Unterscheidung zwischen seine Benachrichtigung Abonnenten für verschiedene Arten von Benachrichtigungen verwendet werden.

public string CustomArgs

DeviceAppInstanceId (schreibgeschützt) Ruft eine ID für die spezifische instance der Anwendung auf dem Smartphone oder einem anderen mobilen Gerät ab.

public Guid DeviceAppInstanceId

LastModifiedTimeStamp (schreibgeschützt) Ruft das Datum und die Uhrzeit der letzten Änderung des Abonnenten ab.

public DateTime LastModifiedTimeStamp

RegistrationTimeStamp (schreibgeschützt) Ruft das Datum und die Uhrzeit der Registrierung des Abonnenten für Benachrichtigungen ab.

public DateTime RegistrationTimeStamp

ServiceToken Ruft Übermittlungskanalinformationen ab, die von einem Benachrichtigungsdienst benötigt werden, z. B. Kanal-URI, oder legt diese fest.

public string ServiceToken

SubscriberType (schreibgeschützt) Ruft den Typ des Geräts ab, z. B. Windows Phone 7.

public SPPhoneNotificationSubscriberType SubscriberType

Informationen über die SPPhoneNotificationSubscriberType -Klasse finden Sie weiter unten in diesem Dokument.

Benutzer (schreibgeschützt) Ruft den Benutzer ab, der sich für Benachrichtigungen registriert hat.

public SPUser User

SPPhoneNotificationSubscriberCollection-Klasse

Eine Auflistung von pushbenachrichtigungsabonnenten. Das Auflistungsobjekt dauert Int32 Indexer.

public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection

Eigenschaften

Count

Ruft die Anzahl der Elemente in der Auflistung ab.

public override int Count

SPPhoneNotificationSubscriberType-Enumeration

Gibt einen Typ des Geräts, die Benachrichtigungen erhalten kann.

SPPhoneNotificationType-Enumeration

Gibt den Typ der Benachrichtigung.

-None -Tile -Toast -Raw

SPWeb-Klasse

Diese Klasse wurden die folgenden Elemente hinzugefügt.

Methoden

DoesPhoneNotificationSubscriberExist Ruft einen Wert ab, der angibt, ob der aktuelle Benutzer ein Abonnent für den angegebenen instance der angegebenen App ist.

public bool DoesPhoneNotificationSubscriberExist(Guid deviceAppInstanceId)

GetPhoneNotificationSubscriber Ruft einen Benachrichtigungsabonnent mit den angegebenen Anwendungs- und Telefon-IDs aus der Liste der Benachrichtigungsabonnementspeicher der Website ab.

public SPPhoneNotificationSubscriber GetPhoneNotificationSubscriber(Guid deviceAppInstanceId)

ParameterdeviceAppInstanceId ist eine ID für die instance der Anwendung auf einem bestimmten Smartphone oder Gerät. Weitere Informationen über die SPPhoneNotificationSubscriber -Klasse finden Sie unter weiter oben in diesem Dokument.

GetPhoneNotificationSubscribers (überladen) Ruft eine Sammlung von Benachrichtigungsabonnenten aus der Abonnementspeicherliste der Website für Benachrichtigungen ab, wobei optional nach der ID der Telefonanwendungen und möglicherweise auch nach einem der folgenden Optionen gefiltert wird: der Benutzer oder einige benutzerdefinierte Argumente.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string customArgs)

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string user)

Parameter

• customArgs sind zusätzliche benutzerdefinierte Informationen, die möglicherweise einige Benachrichtigung-aktivierte Anwendungen verwenden.
• user ist der Benutzer, die für die Benachrichtigungen registriert.

Weitere Informationen über die SPPhoneNotificationSubscriberCollection -Klasse finden Sie unter weiter oben in diesem Dokument.

RegisterPhoneNotificationSubscriber Registriert eine Telefon-App auf einem Telefon, um Benachrichtigungen zu empfangen.

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

Parameter

• subscriberType ist der Typ des Geräts, wie Windows Phone 7.
• deviceAppInstanceId ist die ID für die Instanz der app auf einem bestimmten Telefon oder Gerät.
• serviceToken ist das Token, das vom Benachrichtigungsdienst verwendet wird, die an den Abonnenten Benachrichtigung sendet.

Informationen zu SPPhoneNotificationSubscriberTypefinden Sie weiter oben in diesem Dokument.

UnregisterPhoneNotificationSubscriber Hebt die Registrierung einer Telefon-App auf einem Telefon vom Empfang von Benachrichtigungen auf.

public void UnregisterPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Der ParameterdeviceAppInstanceId ist eine ID für die instance der App auf einem bestimmten Smartphone oder Gerät.

Eigenschaften

PhoneNotificationSubscribers (schreibgeschützt) Ruft eine Sammlung aller Abonnenten von Telefonbenachrichtigungen im Abonnentenspeicher der Website ab.

public SPPhoneNotificationSubscriberCollection PhoneNotificationSubscribers

Informationen über die SPPhoneNotificationSubscriberCollection -Klasse finden Sie weiter oben in diesem Dokument.

WP7NotificationTileContent-Klasse

Stellt den Inhalt der Benachrichtigung über eine Kachel dar.

public sealed class WP7NotificationTileContent : SPPhoneNotificationContent

Konstruktoren

Initialisiert eine neue Instanz der WP7NotificationTileContent-Klasse.

public WP7NotificationTileContent()

Methoden

PreparePayload Transformiert den Inhalt in ein Bytearray , das über die Verbindung an den Benachrichtigungsdienst gesendet wird.

protected internal override byte[] PreparePayload();

Eigenschaften

Count Ruft die Anzahl der Benachrichtigungen ab oder legt sie fest. Muss zwischen-1 bis 99 inklusive sein.

public int Count

Wenn Sie die Eigenschaft auf -1 festlegen, wird die Anzahl der Kacheln nicht geändert.

Titel Ruft den Titel der Kachelbenachrichtigung ab oder legt den Titel fest.

public string Title

BackgroundImagePath Ruft den Pfad zum Hintergrundbild der Kachel ab oder legt diesen fest.

public string BackgroundImagePath

BackBackgroundImagePath Ruft das Hintergrundbild der Rückseite einer gekippten Kachel ab oder legt dieses fest.

public string BackBackgroundImagePath

BackContent Ruft den Inhalt der Rückseite einer gekippten Kachel ab oder legt den Inhalt fest.

public string BackContent

BackTitle Ruft den Titel ab, der auf der Rückseite einer kippenden Kachel angezeigt wird, oder legt diesen fest.

public string BackTitle

TileId Ruft die ID der Kachel ab oder legt diese fest.

public string TileId

WP7NotificationToastContent-Klasse

Stellt den Inhalt der ein Toast-Benachrichtigung an.

public sealed class WP7NotificationToastContent : SPPhoneNotificationContent

Konstruktoren

Initialisiert eine neue Instanz der WP7NotificationToastContent-Klasse.

public WP7NotificationToastContent()

Methoden

PreparePayload Transformiert den Inhalt in ein Bytearray , das über die Verbindung an den Benachrichtigungsdienst gesendet wird.

protected internal override byte[] PreparePayload();

Eigenschaften

Nachricht Ruft die Meldung der Popupbenachrichtigung ab oder legt sie fest.

public string Message

Titel Ruft den Titel der Popupbenachrichtigung ab oder legt diesen fest.

public string Title

Param Ruft benutzerdefinierte Einstellungsdaten ab, die an die empfangende Anwendung übergeben werden, wenn der Benutzer auf die Popupbenachrichtigung antwortet, oder legt diese fest.

public string Param

Diese Eigenschaft kann zum Übergeben von Informationen an die empfangende Anwendung wie eine URL oder eine Reihe von Name / Wert-Paare verwendet werden.

WP7NotificationRawContent-Klasse

Stellt den Inhalt einer unformatierte Benachrichtigung.

public sealed class WP7NotificationRawContent : SPPhoneNotificationContent

Konstruktoren

Initialisiert eine neue Instanz der WP7NotificationRawContent-Klasse.

public WP7NotificationRawContent()

Methoden

PreparePayload Transformiert den Inhalt in ein Bytearray, das über die Verbindung an den Benachrichtigungsdienst gesendet wird.

protected internal override byte[] PreparePayload();

Eigenschaften

Nachricht Ruft die Meldung der unformatierten Benachrichtigung ab oder legt sie fest.

public string Message

WP7PhoneNotificationResponse-Klasse

Stellt das Ergebnis der Versuch, eine Benachrichtigung an eine Windows Phone 7-Abonnenten gesendet.

public WP7PhoneNotificationResponse(SPPhoneNotificationType notificationType, HttpWebResponse response)

Parameter

• notificationType ist der Typ der Benachrichtigung, wie Toast oder Kachel.
• response ist die HTTP-Antwortobjekt, das vom Server generiert wurde.

Weitere Informationen zu SPPhoneNotificationTypefinden Sie unter weiter oben in diesem Dokument.

Eigenschaften

NotificationStatus (schreibgeschützt) Ruft die Benachrichtigung status ab, z. B. Erfolg oder Fehler.

public string NotificationStatus

DeviceConnectionStatus (schreibgeschützt) Ruft die status des Geräts zum Zeitpunkt der Benachrichtigung ab.

public string DeviceConnectionStatus

SubscriptionStatus (schreibgeschützt) Das Abonnement status des Geräts zum Zeitpunkt der Benachrichtigung.

public string SubscriptionStatus

MessageId (schreibgeschützt) Ruft die ID der Nachricht ab, die in der Benachrichtigung gesendet wurde.

public string MessageId

Siehe auch

• Erstellen von Windows Phone-Apps, die auf SharePoint zugreifen
• Vorgehensweise: Konfigurieren und Verwenden von Pushbenachrichtigungen in SharePoint-apps für Windows Phone
• Integrieren von Standort- und Kartenfunktionen in SharePoint
• Übersicht über das SharePoint-Objektmodell für die mobile Clientauthentifizierung